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

geminidb_api

Browse Source 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
This commit is contained in:
Ru, Li Yi 2024-07-04 11:26:33 +00:00 committed by zuul
parent ef239b7410
commit 37b97ffc06
82 changed files with 12430 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1257
docs/geminidb/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

542
docs/geminidb/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

141
docs/geminidb/api-ref/ListApiVersion.html Normal file
View File

File diff suppressed because it is too large Load Diff

141
docs/geminidb/api-ref/ListInstanceTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

339
docs/geminidb/api-ref/ListInstancesByResourceTags.html Normal file
View File

File diff suppressed because it is too large Load Diff

247
docs/geminidb/api-ref/ListSlowLogs.html Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/geminidb/api-ref/PARAMETERS.txt Normal file
View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

164
docs/geminidb/api-ref/ShowApiVersion.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

BIN
docs/geminidb/api-ref/en-us_image_0000001354698252.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

BIN
docs/geminidb/api-ref/en-us_image_0000001354858484.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 110 KiB

BIN
docs/geminidb/api-ref/en-us_image_0000001355018024.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 50 KiB

27
docs/geminidb/api-ref/en-us_topic_0000001404778285.html Normal file
View File

@ -0,0 +1,27 @@
<a name="EN-US_TOPIC_0000001404778285"></a><a name="EN-US_TOPIC_0000001404778285"></a>
<h1 class="topictitle1">APIs v3</h1>
<div id="body0000001404778285"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="topic_300000000.html">API Versions</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000001.html">Versions and Specifications</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000002.html">Instances</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000003.html">Backups and Restorations</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000004.html">Parameter Templates</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000005.html">Tags</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000006.html">Logs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000007.html">Quotas</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="topic_300000016.html">Task Management</a></strong><br>
</li>
</ul>
</div>

12
docs/geminidb/api-ref/nosql_05_0001.html Normal file
View File

@ -0,0 +1,12 @@
<a name="nosql_05_0001"></a><a name="nosql_05_0001"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body0000001354858140"><p id="nosql_05_0001__p494718568310">Welcome to <span id="nosql_05_0001__text0871155531613">GeminiDB</span><span id="nosql_05_0001__text4995152650"></span> API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on <span id="nosql_05_0001__text18255124220177">GeminiDB</span><span id="nosql_05_0001__text06604151150"></span>, such as creating, deleting, and querying DB instances. For details about all supported operations, see <a href="nosql_05_0006.html">API Overview</a>.</p>
<p id="nosql_05_0001__p149473561036">If you want to access <span id="nosql_05_0001__text204659156183">GeminiDB</span> using an API, ensure that you are familiar with <span id="nosql_05_0001__text258511366432">GeminiDB</span> concepts. For details, see the <em id="nosql_05_0001__i7946145317584"><span id="nosql_05_0001__text1566146111711">GeminiDB</span><span id="nosql_05_0001__text562017321653"></span> User Guide</em>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_api_reference.html">Before You Start</a></div>
</div>
</div>

11
docs/geminidb/api-ref/nosql_05_0002.html Normal file
View File

@ -0,0 +1,11 @@
<a name="nosql_05_0002"></a><a name="nosql_05_0002"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body0000001354538564"><p id="nosql_05_0002__p1060082751214"><span id="nosql_05_0002__text615715115518">GeminiDB</span><span id="nosql_05_0002__text73951454252"></span> supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="nosql_05_0007.html">Calling APIs</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_api_reference.html">Before You Start</a></div>
</div>
</div>

11
docs/geminidb/api-ref/nosql_05_0003.html Normal file
View File

@ -0,0 +1,11 @@
<a name="nosql_05_0003"></a><a name="nosql_05_0003"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body0000001355017976"><p id="nosql_05_0003__p3825082612023">An endpoint is the <strong id="nosql_05_0003__b3286644121210">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_api_reference.html">Before You Start</a></div>
</div>
</div>

11
docs/geminidb/api-ref/nosql_05_0004.html Normal file
View File

@ -0,0 +1,11 @@
<a name="nosql_05_0004"></a><a name="nosql_05_0004"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body0000001404937813"><p id="nosql_05_0004__p179691620151010">For more constraints, see the description of each API.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_api_reference.html">Before You Start</a></div>
</div>
</div>

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

@ -0,0 +1,19 @@
<a name="nosql_05_0005"></a><a name="nosql_05_0005"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body0000001405217921"><ul id="nosql_05_0005__en-us_topic_0170093947_ul128965163312"><li id="nosql_05_0005__en-us_topic_0169294976_li489681620316">Account<p id="nosql_05_0005__en-us_topic_0169294976_p1089611169316"><a name="nosql_05_0005__en-us_topic_0169294976_li489681620316"></a><a name="en-us_topic_0169294976_li489681620316"></a>A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.</p>
</li><li id="nosql_05_0005__en-us_topic_0169294976_li15896816113116">IAM User<p id="nosql_05_0005__en-us_topic_0169294976_p589691603117"><a name="nosql_05_0005__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
<p id="nosql_05_0005__en-us_topic_0169294976_p9896121653112">API authentication requires information such as the account name, username, and password.</p>
</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>
</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>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_api_reference.html">Before You Start</a></div>
</div>
</div>

56
docs/geminidb/api-ref/nosql_05_0006.html Normal file
View File

@ -0,0 +1,56 @@
<a name="nosql_05_0006"></a><a name="nosql_05_0006"></a>
<h1 class="topictitle1">API Overview</h1>
<div id="body0000001405097797"><p id="nosql_05_0006__p8060118"><span id="nosql_05_0006__text0871155531613">GeminiDB</span><span id="nosql_05_0006__text0850102568"></span> provides extended APIs. These APIs enable you to use some functions of <span id="nosql_05_0006__text9759811172114">GeminiDB</span><span id="nosql_05_0006__text184671101862"></span>.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_05_0006__table1577981717153" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API description</caption><thead align="left"><tr id="nosql_05_0006__row16810121712155"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.2.2.3.1.1"><p id="nosql_05_0006__p13834717131516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="73%" id="mcps1.3.2.2.3.1.2"><p id="nosql_05_0006__p3883151714159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_05_0006__row1949285720717"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p1349320571278">API Version Queries</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><ul id="nosql_05_0006__ul920143612915"><li id="nosql_05_0006__li220103612913">Query API versions.</li><li id="nosql_05_0006__li1220103642918">Query version information of a specific API.</li></ul>
</td>
</tr>
<tr id="nosql_05_0006__row10180132720818"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p101802271083">DB Version Queries</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p4401153416307">Query version information of a specified type of instances.</p>
</td>
</tr>
<tr id="nosql_05_0006__row1193412428326"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p16935124219321">Instance Specifications Queries</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p183731749153815">Query all instance specifications under a specified condition.</p>
</td>
</tr>
<tr id="nosql_05_0006__row1980621151411"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p16894236114218">Instance Management</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p178077117141">Create, delete, and query instances, scale up or down the instance storage space, add or delete cluster instance nodes, change instance specifications, and change the instance administrator password, instance name, and instance security group.</p>
</td>
</tr>
<tr id="nosql_05_0006__row4515168154914"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p751611854911">Backup and Restoration</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p35171818498">Query and set automated backup policies.</p>
</td>
</tr>
<tr id="nosql_05_0006__row32794918373"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p928104910379">Parameter Management</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p11281549123714">Obtain parameter templates, create a parameter template, modify parameters in a parameter template, apply a parameter template, modify or obtain parameters of a specified instance, obtain parameters of a specified parameter template, and delete a parameter template.</p>
</td>
</tr>
<tr id="nosql_05_0006__row544775318142"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p3448175321416">Tag Management</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p44481353111413">Query resources by tag, batch add and delete tags, and query resource tags.</p>
</td>
</tr>
<tr id="nosql_05_0006__row98441836183714"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="nosql_05_0006__p128465369371">Log Management</p>
</td>
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="nosql_05_0006__p284653633711">Query database slow query logs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

16
docs/geminidb/api-ref/nosql_05_0007.html Normal file
View File

@ -0,0 +1,16 @@
<a name="nosql_05_0007"></a><a name="nosql_05_0007"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body0000001404778289"><p id="nosql_05_0007__p8060118"></p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_05_0008.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0009.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0010.html">Returned Values</a></strong><br>
</li>
</ul>
</div>

171
docs/geminidb/api-ref/nosql_05_0008.html Normal file
View File

File diff suppressed because it is too large Load Diff

44
docs/geminidb/api-ref/nosql_05_0009.html Normal file
View File

@ -0,0 +1,44 @@
<a name="nosql_05_0009"></a><a name="nosql_05_0009"></a>
<h1 class="topictitle1">Authentication</h1>
<div id="body0000001354538568"><p class="MsoNormal" id="nosql_05_0009__p127281235414"><span id="nosql_05_0009__text134372513459">GeminiDB</span><span id="nosql_05_0009__text84381051174512"></span> supports token-based authentication.</p>
<div class="note" id="nosql_05_0009__note16278457204513"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_05_0009__p1627913575453">The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.</p>
</div></div>
<p id="nosql_05_0009__p135791862430">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to a request to get permissions for calling the API.</p>
<p id="nosql_05_0009__p194994815456">If you want to use a token for authentication, you need to obtain the user's token and add <strong id="nosql_05_0009__b6492155018386">X-Auth-Token</strong> to the request header of the service API to make an API call.</p>
<p id="nosql_05_0009__p8530989556">When you call an API to obtain a user token, set <strong id="nosql_05_0009__b1369464943913">auth.scope</strong> in the request body to <strong id="nosql_05_0009__b1869413496395">project</strong>.</p>
<pre class="codeblock" id="nosql_05_0009__codeblock18568163013547">{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<em id="nosql_05_0009__i1570430165414">username</em>",
"password": "<em id="nosql_05_0009__i14570330165415">password</em>",
"domain": {
"name": "<em id="nosql_05_0009__i185706308546">domainname</em>"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxx"
}
}
}
}</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
Content-Type: application/json
<strong id="nosql_05_0009__b847411765114">X-Auth-Token: ABCDEFJ....</strong></pre>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_05_0007.html">Calling APIs</a></div>
</div>
</div>

39
docs/geminidb/api-ref/nosql_05_0010.html Normal file
View File

@ -0,0 +1,39 @@
<a name="nosql_05_0010"></a><a name="nosql_05_0010"></a>
<h1 class="topictitle1">Returned Values</h1>
<div id="body0000001355017980"><div class="section" id="nosql_05_0010__en-us_topic_0170155703_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="nosql_05_0010__en-us_topic_0170155703_p4624111624411">After you send a request, you will receive a response, including a status code, response header, and response body.</p>
<p id="nosql_05_0010__en-us_topic_0170155703_p124381044137">A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see <a href="nosql_status_code.html">Status Codes</a>.</p>
<p id="nosql_05_0010__en-us_topic_0170155703_p2861496519">If status code 201 is returned for calling 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>, the request is successful.</p>
</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>
<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>
<p id="nosql_05_0010__en-us_topic_0170155703_p157041652367">If the following information is returned for calling 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>, the request is successful. The following describes part of the request body.</p>
<pre class="screen" id="nosql_05_0010__en-us_topic_0170155703_screen65818201917">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "<em id="nosql_05_0010__i3794192712288">aaa</em>",
......</pre>
<p id="nosql_05_0010__en-us_topic_0170155703_p127537375412">If an error occurs during API calling, an error code and error message will be displayed. The following is an error response body:</p>
<pre class="screen" id="nosql_05_0010__en-us_topic_0170155703_screen102091730125513">{
"error_msg": "Parameter error",
"error_code": "DBS.200001"
}</pre>
<p id="nosql_05_0010__en-us_topic_0170155703_p1589911464018">In the response, <strong id="nosql_05_0010__b3168706525">error_code</strong> indicates an error code, and <strong id="nosql_05_0010__b21789085219">error_msg</strong> describes the error.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_05_0007.html">Calling APIs</a></div>
</div>
</div>

77
docs/geminidb/api-ref/nosql_05_0011.html Normal file
View File

@ -0,0 +1,77 @@
<a name="nosql_05_0011"></a><a name="nosql_05_0011"></a>
<h1 class="topictitle1">Quick Start</h1>
<div id="body0000001405217925"><p id="nosql_05_0011__en-us_topic_0121682346_p51148444524">This section describes how to create a <span id="nosql_05_0011__text20711320386">GeminiDB Cassandra</span><span id="nosql_05_0011__text99489254812"></span> instance by calling APIs.</p>
<div class="note" id="nosql_05_0011__en-us_topic_0121682346_note44222521746"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_05_0011__p1911091510238">The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently obtaining the token.</p>
</div></div>
<div class="section" id="nosql_05_0011__en-us_topic_0121682346_section872994"><h4 class="sectiontitle">Involved APIs</h4><p class="litext" id="nosql_05_0011__en-us_topic_0121682346_p23385131">If you use a token for authentication, you must obtain the user's token and add <strong id="nosql_05_0011__b1373319353202">X-Auth-Token</strong> to the request message header of the service API when making an API call.</p>
<ul id="nosql_05_0011__en-us_topic_0121682346_ul15147458"><li id="nosql_05_0011__en-us_topic_0121682346_li2109397">API for obtaining tokens from IAM</li><li id="nosql_05_0011__en-us_topic_0121682346_li18984577">API for creating a <span id="nosql_05_0011__text68371333682">GeminiDB Cassandra</span><span id="nosql_05_0011__text4308238688"></span> instance</li></ul>
</div>
<div class="section" id="nosql_05_0011__en-us_topic_0121682346_section7856948"><h4 class="sectiontitle">Procedure</h4><ol id="nosql_05_0011__en-us_topic_0121682346_ol61355793"><li id="nosql_05_0011__en-us_topic_0121682346_li1837051910476">Use a token for authentication by referring to <a href="nosql_05_0009.html">Authentication</a>.</li><li class="msonormal" id="nosql_05_0011__en-us_topic_0121682346_li8863205171315">Send <strong id="nosql_05_0011__b45221916205817">POST https://{<em id="nosql_05_0011__i13519916105813">Endpoint</em>}/v3/{<em id="nosql_05_0011__i25201316145818">project_id</em>}/instances</strong>.</li><li class="msonormal" id="nosql_05_0011__en-us_topic_0121682346_li108635517130">Add <strong id="nosql_05_0011__b578715220583">X-Auth-Token</strong> to the request header.</li><li class="msonormal" id="nosql_05_0011__en-us_topic_0121682346_li1586314581311">Transfer the following parameters in the request body:<div class="note" id="nosql_05_0011__note997910579171"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_05_0011__p13980105715175">Values of <strong id="nosql_05_0011__b137574519589">region</strong> and <strong id="nosql_05_0011__b20376345105810">availability_zone</strong> are only for reference.</p>
<p id="nosql_05_0011__p16641171680">For details about the API for creating instances, see <a href="nosql_05_0014.html">Creating an Instance</a>.</p>
</div></div>
<pre class="codeblock" id="nosql_05_0011__codeblock48031929115">{
"name": "test-cassandra-01",//Instance name
"datastore": {
"type": "cassandra",//Database type
"version": "3.11", //DB engine version
"storage_engine": "rocksDB"//Storage engine
},
"region": "aaa",//Region
"availability_zone": "bbb", //AZ
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",//VPC ID
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",//Subnet ID
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",//Security group ID
"password": "xxxx",//Administrator password
"mode": "Cluster", //Instance type
"flavor": [
{
"num": 3,//Nodes
"size": 500,//Storage space
"storage": "ULTRAHIGH", //Disk type
"spec_code": "geminidb.cassandra.4xlarge.4" //Resource specification code
}
],
"backup_strategy": {
"start_time": "08:00-09:00",//Backup time window
"keep_days": "8"//Retention period of backup files
},
"enterprise_project_id": "0"//Enterprise project ID
}</pre>
<p id="nosql_05_0011__p177519401282">If the following information is displayed, the request is successful:</p>
<pre class="codeblock" id="nosql_05_0011__codeblock15959941171518">{
"id": "39b6a1a278844ac48119d86512e0000bin06",
"name": "test-cassandra-01",
"datastore": {
"type": "cassandra",
"version": "3.11",
"storage_engine": "rocksDB"
},
"created": "2019-10-28 14:10:54",
"status": "creating",
"region": "aaa",
"availability_zone": "bbb",
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
"mode": "Cluster",
"flavor": [
{
"num": 3,
"size": 500,
"storage": "ULTRAHIGH",
"spec_code": "geminidb.cassandra.4xlarge.4"
}
],
"backup_strategy": {
"start_time": "08:00-09:00",
"keep_days": "8"
},
"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
"enterprise_project_id": "0"
}</pre>
<p id="nosql_05_0011__p137584018285">If the request fails, an error code and error information are returned. For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</li></ol>
</div>
</div>

646
docs/geminidb/api-ref/nosql_05_0014.html Normal file
View File

File diff suppressed because it is too large Load Diff

106
docs/geminidb/api-ref/nosql_05_0015.html Normal file
View File

File diff suppressed because it is too large Load Diff

698
docs/geminidb/api-ref/nosql_05_0016.html Normal file
View File

File diff suppressed because it is too large Load Diff

134
docs/geminidb/api-ref/nosql_05_0050.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

148
docs/geminidb/api-ref/nosql_05_0052.html Normal file
View File

File diff suppressed because it is too large Load Diff

164
docs/geminidb/api-ref/nosql_05_0100.html Normal file
View File

File diff suppressed because it is too large Load Diff

115
docs/geminidb/api-ref/nosql_05_0101.html Normal file
View File

File diff suppressed because it is too large Load Diff

113
docs/geminidb/api-ref/nosql_05_0102.html Normal file
View File

File diff suppressed because it is too large Load Diff

134
docs/geminidb/api-ref/nosql_05_0103.html Normal file
View File

File diff suppressed because it is too large Load Diff

247
docs/geminidb/api-ref/nosql_06_0002.html Normal file
View File

File diff suppressed because it is too large Load Diff

266
docs/geminidb/api-ref/nosql_06_0003.html Normal file
View File

File diff suppressed because it is too large Load Diff

137
docs/geminidb/api-ref/nosql_06_0004.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

145
docs/geminidb/api-ref/nosql_06_0006.html Normal file
View File

File diff suppressed because it is too large Load Diff

229
docs/geminidb/api-ref/nosql_06_0007.html Normal file
View File

File diff suppressed because it is too large Load Diff

235
docs/geminidb/api-ref/nosql_06_0008.html Normal file
View File

File diff suppressed because it is too large Load Diff

84
docs/geminidb/api-ref/nosql_06_0009.html Normal file
View File

@ -0,0 +1,84 @@
<a name="nosql_06_0009"></a><a name="nosql_06_0009"></a>
<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>
<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>
</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>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_06_0009__p1972774816241">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_06_0009__p97275481246">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0009__row17723144819241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0009__p87280483244">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0009__p16729184862420">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0009__p8730048152419">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0009__p673113489242">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="nosql_06_0009__row972417482242"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0009__p7732114814249">config_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0009__p177337486243">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0009__p77341848102410">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0009__p07356484246">Parameter template ID.</p>
</td>
</tr>
</tbody>
</table>
</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>
</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>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0009__p1774064852413">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_0009__p3741114822418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0009__row1573764862419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0009__p4741104810246">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_0009__p1474264842418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0009__p17743648172416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0009__p274414812415">User token.</p>
</td>
</tr>
</tbody>
</table>
</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>
</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>
</div>
<div class="section" id="nosql_06_0009__section2754184822415"><h4 class="sectiontitle">Example Responses</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>
<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>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Parameter Templates</a></div>
</div>
</div>

470
docs/geminidb/api-ref/nosql_08_0001.html Normal file
View File

File diff suppressed because it is too large Load Diff

294
docs/geminidb/api-ref/nosql_10_0100.html Normal file
View File

File diff suppressed because it is too large Load Diff

47
docs/geminidb/api-ref/nosql_abnormal_result.html Normal file
View File

@ -0,0 +1,47 @@
<a name="nosql_abnormal_result"></a><a name="nosql_abnormal_result"></a>
<h1 class="topictitle1">Abnormal Request Results</h1>
<div id="body0000001404778601"><ul id="nosql_abnormal_result__u4f311cc3d4d6454f95f1461d067af3e2"><li id="nosql_abnormal_result__l5ca24795c72b4566bc19d49477c0f38b">Abnormal Response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_abnormal_result__t1600a24cde73446fadb04fa4fd4176c9" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="nosql_abnormal_result__rd8bc4cbf15874672964a2f6155ff619b"><th align="left" class="cellrowborder" valign="top" width="21.48%" id="mcps1.3.1.1.1.2.5.1.1"><p id="nosql_abnormal_result__ae933c42bba744097bb871e1e47a3d811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.91%" id="mcps1.3.1.1.1.2.5.1.2"><p id="nosql_abnormal_result__p205904281310">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.84%" id="mcps1.3.1.1.1.2.5.1.3"><p id="nosql_abnormal_result__a70dcf20d1f394d3886396b45ae4ed9e9">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.769999999999996%" id="mcps1.3.1.1.1.2.5.1.4"><p id="nosql_abnormal_result__aab87d22c016b458fbf47a74f2c84238b">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_abnormal_result__r3a83848174a44b2499a0b79476a18366"><td class="cellrowborder" valign="top" width="21.48%" headers="mcps1.3.1.1.1.2.5.1.1 "><p id="nosql_abnormal_result__p6826111184918">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="11.91%" headers="mcps1.3.1.1.1.2.5.1.2 "><p id="nosql_abnormal_result__p1259194251311">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.84%" headers="mcps1.3.1.1.1.2.5.1.3 "><p id="nosql_abnormal_result__a70943c58d7524abcb12b87181c64e2a5">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.769999999999996%" headers="mcps1.3.1.1.1.2.5.1.4 "><p id="nosql_abnormal_result__ac399032b44cd41cd82fc0a0c3e083886">Error code returned when a task submission exception occurs.</p>
</td>
</tr>
<tr id="nosql_abnormal_result__r406296b9b2bf4aafb5e79cf9da8fb201"><td class="cellrowborder" valign="top" width="21.48%" headers="mcps1.3.1.1.1.2.5.1.1 "><p id="nosql_abnormal_result__aa97ccde9ddfc4aa0823d82c4a22f6962">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="11.91%" headers="mcps1.3.1.1.1.2.5.1.2 "><p id="nosql_abnormal_result__p1359542191320">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.84%" headers="mcps1.3.1.1.1.2.5.1.3 "><p id="nosql_abnormal_result__a1ef067712a0141029c3dd10e0df28ab9">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.769999999999996%" headers="mcps1.3.1.1.1.2.5.1.4 "><p id="nosql_abnormal_result__a0994d9a70c8241ba8a2b1fc9b0757e6e">Error description returned when a task submission exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="nosql_abnormal_result__li1789672611102">Example abnormal response<pre class="codeblock" id="nosql_abnormal_result__codeblock974934318538">{
"error_code": "DBS.200001",
"error_msg": "Parameter error"
}</pre>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="nosql_public_parameters.html">Appendixes</a></div>
</div>
</div>

228
docs/geminidb/api-ref/nosql_api_0030.html Normal file
View File

File diff suppressed because it is too large Load Diff

219
docs/geminidb/api-ref/nosql_api_0031.html Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -0,0 +1,19 @@
<a name="nosql_api_reference"></a><a name="nosql_api_reference"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body0000001354698220"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="nosql_05_0001.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0002.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0003.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0004.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="nosql_05_0005.html">Concepts</a></strong><br>
</li>
</ul>
</div>

35
docs/geminidb/api-ref/nosql_change_history02.html Normal file
View File

@ -0,0 +1,35 @@
<a name="nosql_change_history02"></a><a name="nosql_change_history02"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body0000001405098149">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_change_history02__table1623161934518" frame="border" border="1" rules="all"><thead align="left"><tr id="nosql_change_history02__row1062351914512"><th align="left" class="cellrowborder" valign="top" width="38.71%" id="mcps1.3.1.1.3.1.1"><p id="nosql_change_history02__p762312199452">Released On</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.29%" id="mcps1.3.1.1.3.1.2"><p id="nosql_change_history02__p1862411974511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_change_history02__row64421644162618"><td class="cellrowborder" valign="top" width="38.71%" headers="mcps1.3.1.1.3.1.1 "><p id="nosql_change_history02__p944216448265">2023-08-10</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.3.1.1.3.1.2 "><p id="nosql_change_history02__p8442444112617">This issue is the third official release.</p>
<p id="nosql_change_history02__p1835235414336">Updated status codes in <a href="nosql_05_0015.html">Deleting an Instance</a>.</p>
<p id="nosql_change_history02__p3398123811354">Updated status codes in <a href="nosql_05_0050.html">Scaling Up Storage Space of an Instance</a>.</p>
<p id="nosql_change_history02__p03451087337">Updated status codes in <a href="nosql_05_0051.html">Adding Nodes for an Instance</a>.</p>
<p id="nosql_change_history02__p10799138122717">Updated the descriptions of <strong id="nosql_change_history02__b199691620115017">keep_days</strong>, <strong id="nosql_change_history02__b12426824105016">start_time</strong>, and p<strong id="nosql_change_history02__b19324122875010">eriod</strong> in <a href="nosql_api_0031.html">Configuring an Automated Backup Policy</a>.</p>
<p id="nosql_change_history02__p157493198331">Updated status codes in <a href="nosql_05_0100.html">Changing Specifications of an Instance</a>.</p>
</td>
</tr>
<tr id="nosql_change_history02__row1613873012197"><td class="cellrowborder" valign="top" width="38.71%" headers="mcps1.3.1.1.3.1.1 "><p id="nosql_change_history02__p19139103081916">2023-03-15</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.3.1.1.3.1.2 "><p id="nosql_change_history02__p15139113012195">This issue is the second official release.</p>
</td>
</tr>
<tr id="nosql_change_history02__row5228145217338"><td class="cellrowborder" valign="top" width="38.71%" headers="mcps1.3.1.1.3.1.1 "><p id="nosql_change_history02__p15228752193313">2022-07-22</p>
</td>
<td class="cellrowborder" valign="top" width="61.29%" headers="mcps1.3.1.1.3.1.2 "><p id="nosql_change_history02__p1722816527338">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

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