vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/geminidb/api-ref/nosql_06_0003.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

267 lines
19 KiB
HTML
Raw Blame History

<a name="nosql_06_0003"></a><a name="nosql_06_0003"></a>
<h1 class="topictitle1">Creating a Parameter Template</h1>
<div id="body1482813241195"><div class="section" id="nosql_06_0003__section148287245916"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0003__p982982413911">This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.</p>
</div>
<div class="section" id="nosql_06_0003__section1191741294614"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0003__p796395363319">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_06_0003__p180157103412">The new parameter template cannot have the same name as any existing parameter template.</p>
<p id="nosql_06_0003__p326185993412">For configuration item <strong id="nosql_06_0003__b1651511123515">values</strong>, you can enter system-defined parameters that allow for modification.</p>
</div>
<div class="section" id="nosql_06_0003__section10832524699"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0003__p188321247915">POST https://{Endpoint}/v3/{project_id}/configurations</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__table383413241792" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0003__row10833172410916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0003__p9834724990">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_0003__p3834024299">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_0003__p683532413911">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_0003__p1883522412914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row38331241391"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0003__p1983562412912">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0003__p10836172410913">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0003__p983662412911">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0003__p68369241093">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>
<div class="section" id="nosql_06_0003__section283792419915"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0003__row15837624297"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0003__p583819241293">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_0003__p483916249912">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_0003__p1783915241190">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_0003__p1583915245914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row1683814241917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0003__p158409246914">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_0003__p08431124596">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0003__p148435241891">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0003__p88439249915">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__request_CreateConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0003__row384422412914"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0003__p148458249912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_06_0003__p1484619242914">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_06_0003__p188463241495">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_06_0003__p3846924590">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row198441524199"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0003__p1784718241495">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0003__p18478245911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0003__p138470241299">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0003__p78481324991">Parameter template name. It can include a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).</p>
</td>
</tr>
<tr id="nosql_06_0003__row2844624698"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0003__p11848124399">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0003__p1684915247919">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0003__p184911241913">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0003__p3849182414915">Parameter template description. It can contain a maximum of 256 characters except the following special characters: &gt;!&lt;"&amp;'= The value is left blank by default.</p>
</td>
</tr>
<tr id="nosql_06_0003__row184419241995"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0003__p885013243911">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0003__p168507241197">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0003__p58505242913">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0003__p12851624796">Parameter values defined by users based on a default parameter template. Keep the parameter values unchanged by default.</p>
</td>
</tr>
<tr id="nosql_06_0003__row11845132420917"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0003__p28511724996">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0003__p1785118241695">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0003__p1085115241297"><a href="#nosql_06_0003__request_ConfigurationDatastoreOption">ConfigurationDatastoreOption</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0003__p6852152413914">Database object.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_06_0003__request_ConfigurationDatastoreOption"></a><a name="request_ConfigurationDatastoreOption"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__request_ConfigurationDatastoreOption" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ConfigurationDatastoreOption</caption><thead align="left"><tr id="nosql_06_0003__row138522024996"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.1"><p id="nosql_06_0003__p48542241912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.2"><p id="nosql_06_0003__p18547241997">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.5.1.3"><p id="nosql_06_0003__p178552024892">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.4.2.5.1.4"><p id="nosql_06_0003__p1185532419914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row38531424494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.1 "><p id="nosql_06_0003__p78562241498">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="nosql_06_0003__p88566241296">Yes</p>
</td>
<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 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__b15371105413912">cassandra</strong>, indicating that the instances are of the <span id="nosql_06_0003__text165881331168">GeminiDB Cassandra</span> type.</p>
</td>
</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>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.5.1.2 "><p id="nosql_06_0003__p1386016240920">Yes</p>
</td>
<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 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>, indicating that <span id="nosql_06_0003__text12581238111619">GeminiDB Cassandra</span> 3.11 is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0003__section158649241693"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0003__p18649245917"><strong id="nosql_06_0003__b4389194414818">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__response_CreateConfigurationResponseBody" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0003__row12864124298"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0003__p18652241793">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_0003__p1786652417911">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_0003__p158665241092">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row686462420918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0003__p20866824697">configuration</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0003__p28669241790"><a href="#nosql_06_0003__response_ConfigurationResult">ConfigurationResult</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0003__p188671524797">Parameter template information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_06_0003__response_ConfigurationResult"></a><a name="response_ConfigurationResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0003__response_ConfigurationResult" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ConfigurationResult</caption><thead align="left"><tr id="nosql_06_0003__row19867924096"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_06_0003__p686920241195">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.4.2.4.1.2"><p id="nosql_06_0003__p38694248918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.2.4.1.3"><p id="nosql_06_0003__p1186912242093">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0003__row78681224896"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p4870024390">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p98705242093">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p15871162410911">Parameter template ID.</p>
</td>
</tr>
<tr id="nosql_06_0003__row178687242094"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p208716240917">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p19872162413917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p1872162415919">Parameter template name.</p>
</td>
</tr>
<tr id="nosql_06_0003__row6868162415912"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p138729241791">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p1987311247910">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p12873924491">Database version name.</p>
</td>
</tr>
<tr id="nosql_06_0003__row208681241992"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p887472410912">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p98743241595">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p1487442416919">Database name.</p>
</td>
</tr>
<tr id="nosql_06_0003__row16868152410919"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p128751624793">description</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p168751024491">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p1787572411920">Parameter template description</p>
</td>
</tr>
<tr id="nosql_06_0003__row586810241693"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p1387616249910">created</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p168771241917">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p1887712246914">Creation time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0003__p387822415914"><strong id="nosql_06_0003__b6907171145418">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0003__b1592081145412">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_06_0003__row78686241699"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0003__p1887813241992">updated</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0003__p787816241598">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0003__p6879924394">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0003__p1387910247914"><strong id="nosql_06_0003__b13440155915566">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0003__b11441115914566">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0003__section087914241196"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0003__ul688012241914"><li id="nosql_06_0003__li6314653181816">URI example<pre class="screen" id="nosql_06_0003__screen3314205361815">POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations</pre>
</li><li id="nosql_06_0003__li08818248914">Creating a parameter template for GeminiDB Cassandra instances<pre class="screen" id="nosql_06_0003__screen1388232420918">{
"name" : "configuration_test",
"description" : "configuration_test",
"values" : {
"max_connections" : "10",
"autocommit" : "OFF"
},
"datastore" : {
"type" : "cassandra",
"version" : "3.11"
}
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0003__section20884324798"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0003__p588413245910"><strong id="nosql_06_0003__b873224212575">Status code: 200</strong></p>
<p id="nosql_06_0003__p108851324994">Success</p>
<pre class="screen" id="nosql_06_0003__screen17885824891">{
"configuration" : {
"id" : "463b4b58d0e84e2b95605dea4552fdpr06",
"name" : "configuration_test",
"datastore_version_name" : "3.11",
"datastore_name" : "cassandra",
"description" : "configuration_test",
"created" : "2020-03-09T08:27:56+0800",
"updated" : "2020-03-09T08:27:56+0800"
}
}</pre>
</div>
<div class="section" id="nosql_06_0003__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0003__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0003__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0003__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