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

nosql_api

Browse Source 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
This commit is contained in:
Wang , Deng Ke 2023-11-05 19:26:26 +00:00 committed by zuul
parent 04d4597cf3
commit 4828616622
12 changed files with 38 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/gaussdb_nosql/api-ref/ALL_META.TXT.json
View File

@ -1,4 +1,7 @@
[ [
{
"dockw":"API Reference"
},
{ {
"uri":"nosql_api_reference.html", "uri":"nosql_api_reference.html",
"node_id":"nosql_api_reference.xml", "node_id":"nosql_api_reference.xml",

2
docs/gaussdb_nosql/api-ref/BatchTagAction.html
View File

@ -84,7 +84,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="BatchTagAction__p16760257105011">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="BatchTagAction__p16760257105011">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="BatchTagAction__p13761257115012">Operation identifier. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="BatchTagAction__p13761257115012">Operation identifier. The value can be:</p>
<ul id="BatchTagAction__ul576285735015"><li id="BatchTagAction__li476375705015"><strong id="BatchTagAction__b117328101983">create</strong>: indicates that tags are added.</li><li id="BatchTagAction__li276410579504"><strong id="BatchTagAction__b1825412561786">delete</strong>: indicates that tags are deleted.</li></ul> <ul id="BatchTagAction__ul576285735015"><li id="BatchTagAction__li476375705015"><strong id="BatchTagAction__b117328101983">create</strong>, indicating that tags are added.</li><li id="BatchTagAction__li276410579504"><strong id="BatchTagAction__b1825412561786">delete</strong>, indicating that tags are deleted.</li></ul>
</td> </td>
</tr> </tr>
<tr id="BatchTagAction__row07507576508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="BatchTagAction__p147651557195015">tags</p> <tr id="BatchTagAction__row07507576508"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="BatchTagAction__p147651557195015">tags</p>

2
docs/gaussdb_nosql/api-ref/ListApiVersion.html
View File

@ -112,7 +112,7 @@
</table> </table>
</div> </div>
</div> </div>
<div class="section" id="ListApiVersion__section36371052115717"><h4 class="sectiontitle">Request Example</h4><div class="p" id="ListApiVersion__p69882712116">URI example<pre class="screen" id="ListApiVersion__screen798815715214">GET https://{Endpoint}/</pre> <div class="section" id="ListApiVersion__section36371052115717"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="ListApiVersion__p69882712116">URI example<pre class="screen" id="ListApiVersion__screen798815715214">GET https://{Endpoint}/</pre>
</div> </div>
</div> </div>
<div class="section" id="ListApiVersion__section18642752155712"><h4 class="sectiontitle">Example Response</h4><p id="ListApiVersion__p17643352125716"><strong id="ListApiVersion__b179773118113">Status code: 200</strong></p> <div class="section" id="ListApiVersion__section18642752155712"><h4 class="sectiontitle">Example Response</h4><p id="ListApiVersion__p17643352125716"><strong id="ListApiVersion__b179773118113">Status code: 200</strong></p>

2
docs/gaussdb_nosql/api-ref/ShowApiVersion.html
View File

@ -135,7 +135,7 @@
</table> </table>
</div> </div>
</div> </div>
<div class="section" id="ShowApiVersion__section696142211584"><h4 class="sectiontitle">Request Example</h4><div class="p" id="ShowApiVersion__p111501658152111">URI example<pre class="screen" id="ShowApiVersion__screen95044915155">GET https://{Endpoint}/v3</pre> <div class="section" id="ShowApiVersion__section696142211584"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="ShowApiVersion__p111501658152111">URI example<pre class="screen" id="ShowApiVersion__screen95044915155">GET https://{Endpoint}/v3</pre>
</div> </div>
</div> </div>
<div class="section" id="ShowApiVersion__section6100112245818"><h4 class="sectiontitle">Example Response</h4><p id="ShowApiVersion__p141001422195810"><strong id="ShowApiVersion__b13646174119410">Status code: 200</strong></p> <div class="section" id="ShowApiVersion__section6100112245818"><h4 class="sectiontitle">Example Response</h4><p id="ShowApiVersion__p141001422195810"><strong id="ShowApiVersion__b13646174119410">Status code: 200</strong></p>

12
docs/gaussdb_nosql/api-ref/nosql_05_0014.html
View File

@ -151,7 +151,7 @@
<td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0014__p13442118105110">String</p> <td class="cellrowborder" valign="top" width="20.61%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_05_0014__p13442118105110">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0014__p9443198145111">Instance type. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0014__p9443198145111">Instance type. The value can be:</p>
<ul id="nosql_05_0014__ul54444815115"><li id="nosql_05_0014__li844413855112"><strong id="nosql_05_0014__b196312113137">Cluster</strong>: indicates that GaussDB(for Cassandra) cluster instances are supported.</li></ul> <ul id="nosql_05_0014__ul54444815115"><li id="nosql_05_0014__li844413855112"><strong id="nosql_05_0014__b196312113137">Cluster</strong>, indicating that GaussDB(for Cassandra) cluster instances are supported.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_05_0014__row237019865116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0014__p134512812514">flavor</p> <tr id="nosql_05_0014__row237019865116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_05_0014__p134512812514">flavor</p>
@ -200,7 +200,7 @@
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0014__p64733817518">Whether SSL is enabled.</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_05_0014__p64733817518">Whether SSL is enabled.</p>
<p id="nosql_05_0014__p1247478125111">The value can be:</p> <p id="nosql_05_0014__p1247478125111">The value can be:</p>
<ul id="nosql_05_0014__ul12474148135110"><li id="nosql_05_0014__li1947514875115"><strong id="nosql_05_0014__b176871634104318">0</strong>: indicates that SSL is disabled by default.</li><li id="nosql_05_0014__li447517810513"><strong id="nosql_05_0014__b12858937447">1</strong>: indicates that SSL is enabled by default.</li><li id="nosql_05_0014__li124766812517">If this parameter is not transferred, SSL is disabled by default.</li></ul> <ul id="nosql_05_0014__ul12474148135110"><li id="nosql_05_0014__li1947514875115"><strong id="nosql_05_0014__b176871634104318">0</strong>, indicating that SSL is disabled by default.</li><li id="nosql_05_0014__li447517810513"><strong id="nosql_05_0014__b12858937447">1</strong>, indicating that SSL is enabled by default.</li><li id="nosql_05_0014__li124766812517">If this parameter is not transferred, SSL is disabled by default.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -234,7 +234,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_05_0014__p165139816519">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_05_0014__p165139816519">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0014__p18514782514">Database version. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0014__p18514782514">Database version. The value can be:</p>
<ul id="nosql_05_0014__ul1451678145112"><li id="nosql_05_0014__li5516788513"><strong id="nosql_05_0014__b8736191575910">3.11</strong>: indicates that GaussDB(for Cassandra) 3.11 is supported.</li></ul> <ul id="nosql_05_0014__ul1451678145112"><li id="nosql_05_0014__li5516788513"><strong id="nosql_05_0014__b8736191575910">3.11</strong>, indicating that GaussDB(for Cassandra) 3.11 is supported.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_05_0014__row24901981512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nosql_05_0014__p2052478145119">storage_engine</p> <tr id="nosql_05_0014__row24901981512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nosql_05_0014__p2052478145119">storage_engine</p>
@ -244,7 +244,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_05_0014__p115261983511">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_05_0014__p115261983511">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0014__p14527489516">Storage engine. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_05_0014__p14527489516">Storage engine. The value can be:</p>
<ul id="nosql_05_0014__ul16528118165111"><li id="nosql_05_0014__li10528887514"><strong id="nosql_05_0014__b1033533317">rocksDB</strong>: indicates that the storage engine is RocksDB.</li></ul> <ul id="nosql_05_0014__ul16528118165111"><li id="nosql_05_0014__li10528887514"><strong id="nosql_05_0014__b1033533317">rocksDB</strong>, indicating that the storage engine is RocksDB.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -481,7 +481,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0014__p159718916511">String</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0014__p159718916511">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0014__p18977914511">Database version. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0014__p18977914511">Database version. The value can be:</p>
<ul id="nosql_05_0014__ul69829155116"><li id="nosql_05_0014__li79849115112"><strong id="nosql_05_0014__b19753554456">3.11</strong>: indicates that GaussDB(for Cassandra) 3.11 is supported.</li></ul> <ul id="nosql_05_0014__ul69829155116"><li id="nosql_05_0014__li79849115112"><strong id="nosql_05_0014__b19753554456">3.11</strong>, indicating that GaussDB(for Cassandra) 3.11 is supported.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_05_0014__row1565317885111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0014__p161001193516">storage_engine</p> <tr id="nosql_05_0014__row1565317885111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_05_0014__p161001193516">storage_engine</p>
@ -489,7 +489,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0014__p0100189115112">String</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_05_0014__p0100189115112">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0014__p1410118913517">Storage engine. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_05_0014__p1410118913517">Storage engine. The value can be:</p>
<ul id="nosql_05_0014__ul111019925118"><li id="nosql_05_0014__li101013919511"><strong id="nosql_05_0014__b76377418296">rocksDB</strong>: indicates that the storage engine is RocksDB.</li></ul> <ul id="nosql_05_0014__ul111019925118"><li id="nosql_05_0014__li101013919511"><strong id="nosql_05_0014__b76377418296">rocksDB</strong>, indicating that the storage engine is RocksDB.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>

4
docs/gaussdb_nosql/api-ref/nosql_06_0003.html
View File

@ -123,7 +123,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_06_0003__p38578242914">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_06_0003__p38578242914">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_06_0003__p18577245913">Database type. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_06_0003__p18577245913">Database type. The value can be:</p>
<p id="nosql_06_0003__p935105325019"><strong id="nosql_06_0003__b26631030410">cassandra</strong>: indicates that the target instances are of the GaussDB(for Cassandra) type.</p> <p id="nosql_06_0003__p935105325019"><strong id="nosql_06_0003__b26631030410">cassandra</strong>, indicating that the target instances are of the GaussDB(for Cassandra) type.</p>
</td> </td>
</tr> </tr>
<tr id="nosql_06_0003__row1685332410918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nosql_06_0003__p785914240910">version</p> <tr id="nosql_06_0003__row1685332410918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nosql_06_0003__p785914240910">version</p>
@ -133,7 +133,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_06_0003__p886052417918">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.3 "><p id="nosql_06_0003__p886052417918">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_06_0003__p186016242913">Database version. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.4.2.5.1.4 "><p id="nosql_06_0003__p186016242913">Database version. The value can be:</p>
<p id="nosql_06_0003__p1057204374713"><strong id="nosql_06_0003__b194196134612">3.11</strong>: indicates that GaussDB(for Cassandra) 3.11 is supported.</p> <p id="nosql_06_0003__p1057204374713"><strong id="nosql_06_0003__b194196134612">3.11</strong>, indicating that GaussDB(for Cassandra) 3.11 is supported.</p>
</td> </td>
</tr> </tr>
</tbody> </tbody>

2
docs/gaussdb_nosql/api-ref/nosql_06_0005.html
View File

@ -109,7 +109,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0005__p4877105519100">Boolean</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0005__p4877105519100">Boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0005__p12877135510109">Whether the task for applying the parameter template is successfully submitted. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0005__p12877135510109">Whether the task for applying the parameter template is successfully submitted. The value can be:</p>
<ul id="nosql_06_0005__ul887711553108"><li id="nosql_06_0005__li1987765571016"><strong id="nosql_06_0005__b914862372311">true</strong>: indicates the task is successfully submitted.</li><li id="nosql_06_0005__li17877955171018"><strong id="nosql_06_0005__b2016916295234">false</strong>: indicates the task fails to be submitted.</li></ul> <ul id="nosql_06_0005__ul887711553108"><li id="nosql_06_0005__li1987765571016"><strong id="nosql_06_0005__b914862372311">true</strong>, indicating the task is successfully submitted.</li><li id="nosql_06_0005__li17877955171018"><strong id="nosql_06_0005__b2016916295234">false</strong>, indicating the task fails to be submitted.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>

2
docs/gaussdb_nosql/api-ref/nosql_06_0006.html
View File

@ -110,7 +110,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0006__p16741201281513">Boolean</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0006__p16741201281513">Boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0006__p174211271510">Whether the instance needs to be restarted. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0006__p174211271510">Whether the instance needs to be restarted. The value can be:</p>
<ul id="nosql_06_0006__ul57431212101516"><li id="nosql_06_0006__li474301213152"><strong id="nosql_06_0006__b868882712919">true</strong>: indicates that the instance needs to be restarted.</li><li id="nosql_06_0006__li1174441214154"><strong id="nosql_06_0006__b168944016297">false</strong>: indicates that the instance does not need to be restarted.</li></ul> <ul id="nosql_06_0006__ul57431212101516"><li id="nosql_06_0006__li474301213152"><strong id="nosql_06_0006__b868882712919">true</strong>, indicating that the instance needs to be restarted.</li><li id="nosql_06_0006__li1174441214154"><strong id="nosql_06_0006__b168944016297">false</strong>, indicating that the instance does not need to be restarted.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>

4
docs/gaussdb_nosql/api-ref/nosql_06_0008.html
View File

@ -162,7 +162,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p106831137132215">Boolean</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p106831137132215">Boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p13684103772214">Whether the instance needs to be restarted. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p13684103772214">Whether the instance needs to be restarted. The value can be:</p>
<ul id="nosql_06_0008__ul96861537192211"><li id="nosql_06_0008__li19687173714223"><strong id="nosql_06_0008__b176512109486">false</strong>: indicates that the instance does not need to be restarted.</li><li id="nosql_06_0008__li10689183712218"><strong id="nosql_06_0008__b446141513482">true</strong>: indicates that the instance needs to be restarted.</li></ul> <ul id="nosql_06_0008__ul96861537192211"><li id="nosql_06_0008__li19687173714223"><strong id="nosql_06_0008__b176512109486">false</strong>, indicating that the instance does not need to be restarted.</li><li id="nosql_06_0008__li10689183712218"><strong id="nosql_06_0008__b446141513482">true</strong>, indicating that the instance needs to be restarted.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_06_0008__row6669183782219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p2690163719229">readonly</p> <tr id="nosql_06_0008__row6669183782219"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p2690163719229">readonly</p>
@ -170,7 +170,7 @@
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p1069183711227">Boolean</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p1069183711227">Boolean</p>
</td> </td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p1769313742210">Whether the parameter is read-only. The value can be:</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p1769313742210">Whether the parameter is read-only. The value can be:</p>
<ul id="nosql_06_0008__ul7694153712215"><li id="nosql_06_0008__li6694937102215"><strong id="nosql_06_0008__b9314622154812">false</strong>: indicates that the parameter is not read-only.</li><li id="nosql_06_0008__li76952374227"><strong id="nosql_06_0008__b1899817259482">true</strong>: indicates that the parameter is read-only.</li></ul> <ul id="nosql_06_0008__ul7694153712215"><li id="nosql_06_0008__li6694937102215"><strong id="nosql_06_0008__b9314622154812">false</strong>, indicating that the parameter is not read-only.</li><li id="nosql_06_0008__li76952374227"><strong id="nosql_06_0008__b1899817259482">true</strong>, indicating that the parameter is read-only.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_06_0008__row96694378224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p2069863722219">value_range</p> <tr id="nosql_06_0008__row96694378224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p2069863722219">value_range</p>

20
docs/gaussdb_nosql/api-ref/nosql_api_0030.html
View File

@ -56,7 +56,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_api_0030__p4781155832911">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_api_0030__p4781155832911">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_api_0030__p207811158102913">Backup policy type. This parameter is available only to GaussDB(for Cassandra). The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_api_0030__p207811158102913">Backup policy type. This parameter is available only to GaussDB(for Cassandra). The value can be:</p>
<ul id="nosql_api_0030__ul14781858152911"><li id="nosql_api_0030__li1578110589296"><strong id="nosql_api_0030__b2079511385346">Instance</strong>: indicates that an instance backup is queried.</li><li id="nosql_api_0030__li1782195812292"><strong id="nosql_api_0030__b12470125514344">DatabaseTable</strong>: indicates that a database or table backup is queried.</li></ul> <ul id="nosql_api_0030__ul14781858152911"><li id="nosql_api_0030__li1578110589296"><strong id="nosql_api_0030__b2079511385346">Instance</strong>, indicating that an instance backup is queried.</li><li id="nosql_api_0030__li1782195812292"><strong id="nosql_api_0030__b12470125514344">DatabaseTable</strong>, indicating that a database or table backup is queried.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>
@ -131,6 +131,20 @@
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_api_0030__p614303144420">Backup retention days</p> <td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_api_0030__p614303144420">Backup retention days</p>
</td> </td>
</tr> </tr>
<tr id="nosql_api_0030__row162441559103016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_api_0030__p96399211617">differential_period</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_api_0030__p1463922151613">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_api_0030__p1863916211163">Differential backup interval. Interval for automatic differential backup. Its value can be <strong id="nosql_api_0030__b11395121074719">30</strong>, <strong id="nosql_api_0030__b18395910164714">60</strong>, <strong id="nosql_api_0030__b18395310114716">180</strong>, <strong id="nosql_api_0030__b3396141074712">360</strong>, <strong id="nosql_api_0030__b14396141024718">720</strong>, or <strong id="nosql_api_0030__b93961310204716">1440</strong>. The unit is minute. If the value is <strong id="nosql_api_0030__b73191713133416">0</strong>, differential backup is disabled. Differential backup works based on incremental backup, and differential backup interval must be longer than incremental backup interval.</p>
</td>
</tr>
<tr id="nosql_api_0030__row34971727314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_api_0030__p106391721163">incremental_period</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_api_0030__p166395281610">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_api_0030__p2063916251611">Incremental backup interval, in minutes. If the value is <strong id="nosql_api_0030__b1719518390405">0</strong>, incremental backup is disabled.</p>
</td>
</tr>
<tr id="nosql_api_0030__row9140133112449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_api_0030__p131459311442">start_time</p> <tr id="nosql_api_0030__row9140133112449"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_api_0030__p131459311442">start_time</p>
</td> </td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_api_0030__p13145123194411">String</p> <td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_api_0030__p13145123194411">String</p>
@ -186,7 +200,9 @@
"backup_policy" : { "backup_policy" : {
"keep_days" : 7, "keep_days" : 7,
"start_time" : "19:00-20:00", "start_time" : "19:00-20:00",
"period" : "1,2,4,5,6" "period" : "1,2,4,5,6",
"incremental_period": "0",
"differential_period": "0"
}, },
"database_tables" : [ { "database_tables" : [ {
"database_name" : "databaseNameA", "database_name" : "databaseNameA",

2
docs/gaussdb_nosql/api-ref/nosql_database_version.html
View File

@ -33,7 +33,7 @@
<td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_database_version__p1927092315818">String</p> <td class="cellrowborder" valign="top" width="19.33%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_database_version__p1927092315818">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40.67%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_database_version__p13270172312584">Database type. The value can be:</p> <td class="cellrowborder" valign="top" width="40.67%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_database_version__p13270172312584">Database type. The value can be:</p>
<ul id="nosql_database_version__ul11271152335813"><li id="nosql_database_version__li127116238584"><strong id="nosql_database_version__b1193074104">cassandra</strong>: indicates that the instances are of the GaussDB(for Cassandra) type.</li></ul> <ul id="nosql_database_version__ul11271152335813"><li id="nosql_database_version__li127116238584"><strong id="nosql_database_version__b1193074104">cassandra</strong>, indicating that the instances are of the GaussDB(for Cassandra) type.</li></ul>
</td> </td>
</tr> </tr>
</tbody> </tbody>

2
docs/gaussdb_nosql/api-ref/nosql_instance_specification.html
View File

@ -47,7 +47,7 @@
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_instance_specification__p133861726141116">String</p> <td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_instance_specification__p133861726141116">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_instance_specification__p4386172691116">Database type. The value can be:</p> <td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_instance_specification__p4386172691116">Database type. The value can be:</p>
<ul id="nosql_instance_specification__ul4386192661114"><li id="nosql_instance_specification__li193861026141118"><strong id="nosql_instance_specification__b177191410142513">cassandra</strong>: indicates that the instances are of the GaussDB(for Cassandra) type.</li><li id="nosql_instance_specification__li16388192661116">If this parameter is not transferred, the default value is <strong id="nosql_instance_specification__b5703105718284">cassandra</strong>.</li></ul> <ul id="nosql_instance_specification__ul4386192661114"><li id="nosql_instance_specification__li193861026141118"><strong id="nosql_instance_specification__b177191410142513">cassandra</strong>, indicating that the instances are of the GaussDB(for Cassandra) type.</li><li id="nosql_instance_specification__li16388192661116">If this parameter is not transferred, the default value is <strong id="nosql_instance_specification__b5703105718284">cassandra</strong>.</li></ul>
</td> </td>
</tr> </tr>
<tr id="nosql_instance_specification__row53821326131119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_instance_specification__p1838952631110">offset</p> <tr id="nosql_instance_specification__row53821326131119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_instance_specification__p1838952631110">offset</p>