vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_06_0002.html
Ru, Li Yi 37b97ffc06 geminidb_api 
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>
2024-07-04 11:26:33 +00:00

248 lines
18 KiB
HTML
Raw Blame History

<a name="nosql_06_0002"></a><a name="nosql_06_0002"></a>
<h1 class="topictitle1">Obtaining Parameter Templates</h1>
<div id="body13537176819"><div class="section" id="nosql_06_0002__section18353517281"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0002__p13354417981">This API is used to obtain parameter templates, including all of the default and custom parameter templates.</p>
</div>
<div class="section" id="nosql_06_0002__section235152119396"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0002__p1051945243413">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_06_0002__section53581517785"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0002__p0358161713815">GET https://{Endpoint}/v3.1/{project_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__table33591617183" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0002__row103580174817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0002__p83608178819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_06_0002__p7360141712813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_06_0002__p1436061713820">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_0002__p136111171783">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row1535918172820"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0002__p163618171187">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0002__p1736111178813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0002__p18361111710810">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0002__p93621817382">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>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__table3363717083" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="nosql_06_0002__row136261714819"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="nosql_06_0002__p1236311172811">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="nosql_06_0002__p1436310172818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="nosql_06_0002__p16364417987">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="nosql_06_0002__p836419171684">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row1436212171882"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_06_0002__p036451710810">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_06_0002__p8365131713813">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_06_0002__p736512171820">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_06_0002__p173658178818">Index offset.</p>
<ul id="nosql_06_0002__ul83669178813"><li id="nosql_06_0002__li736691716810">If <strong id="nosql_06_0002__b6696043161113">offset</strong> is set to <em id="nosql_06_0002__i2698114314111">N</em>, the resource query starts from the N+1 piece of data. If <strong id="nosql_06_0002__b17698184318115">action</strong> is set to <strong id="nosql_06_0002__b1669904361111">filter</strong>, <strong id="nosql_06_0002__b10700343131110">offset</strong> is <strong id="nosql_06_0002__b1701124391114">0</strong> by default, indicating that the query starts from the first piece of data.</li><li id="nosql_06_0002__li8366217385">The value must be a positive integer.</li></ul>
</td>
</tr>
<tr id="nosql_06_0002__row1536212171387"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="nosql_06_0002__p173662171387">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="nosql_06_0002__p1936616171682">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="nosql_06_0002__p23671317886">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="nosql_06_0002__p1936791711813">Maximum number of instances that can be queried.</p>
<ul id="nosql_06_0002__ul203671717486"><li id="nosql_06_0002__li23671017088">The value ranges from <strong id="nosql_06_0002__b128057212117">1</strong> to <strong id="nosql_06_0002__b3805122152112">100</strong>.</li><li id="nosql_06_0002__li53671317584">If this parameter is not transferred, the first 100 records are queried by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0002__section73687176814"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0002__row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0002__p936941712818">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0002__p2369717883">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="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_0002__p1937018171381">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0002__p1937017171284">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_06_0002__p15371517489">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="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_0002__p1237131714819">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0002__section23721917183"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0002__p173721171185"><strong id="nosql_06_0002__b165231027192112">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__response_ListConfigurationsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0002__row537301713812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0002__p1637491717812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_06_0002__p19375917586">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_06_0002__p337519171088">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row237431717814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0002__p137517171283">count</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0002__p1537619176815">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0002__p1237616171786">Total number of records.</p>
</td>
</tr>
<tr id="nosql_06_0002__row014316341765"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0002__p10144234568">quota</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0002__p181457347614">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0002__p1614512345610">Maximum number of custom parameter templates that a user can create.</p>
</td>
</tr>
<tr id="nosql_06_0002__row193740175811"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0002__p037617175813">configurations</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0002__p1937610171883">Array of <a href="#nosql_06_0002__response_ListConfigurationsResult">ListConfigurationsResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0002__p537717171287">Parameter templates.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_06_0002__response_ListConfigurationsResult"></a><a name="response_ListConfigurationsResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0002__response_ListConfigurationsResult" frame="border" border="1" rules="all"><caption><b>Table 5 </b>ListConfigurationsResult</caption><thead align="left"><tr id="nosql_06_0002__row12378161710816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_06_0002__p1337911715819">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.27%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_06_0002__p4380417185">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="63.73%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_06_0002__p1738011715812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0002__row9378191718813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p113801617682">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p123811617881">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p638121713814">Parameter template ID.</p>
</td>
</tr>
<tr id="nosql_06_0002__row03781417385"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p93811173812">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p93811917885">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p93823171481">Parameter template name.</p>
</td>
</tr>
<tr id="nosql_06_0002__row23786171988"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p12382617684">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p13382317081">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p17383201719816">Parameter template description.</p>
</td>
</tr>
<tr id="nosql_06_0002__row1137871717810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p1638361719812">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p13383717482">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p3383317680">Database version name.</p>
</td>
</tr>
<tr id="nosql_06_0002__row63781717985"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p33841017382">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p11384817688">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p183840172815">Database name.</p>
</td>
</tr>
<tr id="nosql_06_0002__row437819171988"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p19385141718813">created</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p138514177811">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p538513171684">Creation time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0002__p1138616171384"><strong id="nosql_06_0002__b14958154713254">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0002__b1395964712258">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_06_0002__row937915171784"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p183861617880">updated</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p1038721715818">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p138791719814">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0002__p238713171185"><strong id="nosql_06_0002__b18593717287">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0002__b39516378282">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_06_0002__row922835778"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p19236351716">mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p1330318483711">String</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p89591358972">Instance type. The value can be:</p>
<p id="nosql_06_0002__p47561685"><strong id="nosql_06_0002__b19613182021219">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0002__text195724581167">GeminiDB Cassandra</span> cluster type.</p>
<p id="nosql_06_0002__p8276587814"><strong id="nosql_06_0002__b165477419128">Cluster</strong>, indicating that the instance is of the <span id="nosql_06_0002__text189784914813">GeminiDB Influx</span> cluster type.</p>
</td>
</tr>
<tr id="nosql_06_0002__row1737918175816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0002__p1938813174816">user_defined</p>
</td>
<td class="cellrowborder" valign="top" width="16.27%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0002__p5388131716810">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="63.73%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0002__p8388161714811">Whether the parameter template is a custom template. The value can be:</p>
<ul id="nosql_06_0002__ul9388141713817"><li id="nosql_06_0002__li19389417788"><strong id="nosql_06_0002__b18628145335314">false</strong>, indicating that the parameter template is a default parameter template.</li><li id="nosql_06_0002__li1638919173819"><strong id="nosql_06_0002__b52178326546">true</strong>, indicating that the parameter template is a custom template.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0002__section13891717586"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0002__p1536118118273">URI example<pre class="screen" id="nosql_06_0002__screen16871929144">GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&amp;limit=10 </pre>
</div>
</div>
<div class="section" id="nosql_06_0002__section163911217587"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0002__p153919173810"><strong id="nosql_06_0002__b19115775322">Status code: 200</strong></p>
<p id="nosql_06_0002__p163911172087">Success</p>
<pre class="screen" id="nosql_06_0002__screen2392171719812">{
"count" : 2,
"quota": 100,
"configurations" : [ {
"id" : "887ea0d1bb0843c49e8d8e5a09a95652pr06",
"name" : "configuration_test",
"description" : "configuration_test",
"datastore_version_name" : "3.11",
"datastore_name" : "cassandra",
"created" : "2019-05-15T11:53:34+0000",
"updated" : "2019-05-15T11:53:34+0000",
"mode": "Cluster",
"user_defined" : true
}, {
"id" : "3bc1e9cc0d34404b9225ed7a58fb284epr06",
"name" : "Default-Cassandra-3.11",
"description" : "Default parameter group for cassandra 3.11",
"datastore_version_name" : "3.11",
"datastore_name" : "cassandra",
"created" : "2019-05-27T03:38:51+0000",
"updated" : "2019-05-27T03:38:51+0000",
"mode": "Cluster",
"user_defined" : false
} ]
}</pre>
</div>
<div class="section" id="nosql_06_0002__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0002__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0002__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0002__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>
View Git Blame Copy Permalink