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

236 lines
17 KiB
HTML
Raw Blame History

<a name="nosql_06_0008"></a><a name="nosql_06_0008"></a>
<h1 class="topictitle1">Obtaining Parameters of a Specified Parameter Template</h1>
<div id="body457810374224"><div class="section" id="nosql_06_0008__section85798371226"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0008__p758012372225">This API is used to obtain information about parameters of a specified parameter template.</p>
</div>
<div class="section" id="nosql_06_0008__section68941910476"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0008__p12792357124410">This API supports GeminiDB Cassandra instances.</p>
</div>
<div class="section" id="nosql_06_0008__section45931737162213"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0008__p165941137102217">GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__table145971374225" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0008__row65968372220"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0008__p125981637192213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_06_0008__p17599183720227">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_06_0008__p16600113713224">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_0008__p10601113720221">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0008__row45961537102212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0008__p1860343752212">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0008__p360593792218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0008__p14606133702220">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0008__p18607193782216">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_0008__row18596437112214"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0008__p126082037182213">config_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0008__p18609103712228">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0008__p461083732211">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0008__p1561293752218">Parameter template ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0008__section20613173712213"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0008__row1561433732215"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0008__p4616143782218">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_06_0008__p146171737162218">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_06_0008__p9618153714228">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_0008__p961917377224">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0008__row4614133772210"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0008__p11621737182218">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_0008__p196221237152216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0008__p16234370228">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0008__p1662419375224">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0008__section0625153752220"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0008__p1262653772219"><strong id="nosql_06_0008__b15182133812444">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__response_ShowConfigurationDetailResponseBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="nosql_06_0008__row16281637122214"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_06_0008__p663118372229">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_06_0008__p19632103714221">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_0008__p0633737102217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0008__row14628537142218"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p46341372224">id</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p136355371225">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p36361637192215">Parameter template ID.</p>
</td>
</tr>
<tr id="nosql_06_0008__row9628173742216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p563803772211">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p1463983742217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p0640123722213">Parameter template name.</p>
</td>
</tr>
<tr id="nosql_06_0008__row2062813376225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p176412037172213">description</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p116424371223">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p196434371223">Parameter template description.</p>
</td>
</tr>
<tr id="nosql_06_0008__row17628737122215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p164423715221">datastore_version_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p2645937162220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p4646123715225">Database version name.</p>
</td>
</tr>
<tr id="nosql_06_0008__row9628123742215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p76472373224">datastore_name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p164953792219">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p1652143782211">Database name.</p>
</td>
</tr>
<tr id="nosql_06_0008__row136281337172216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p17653183722211">created</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p13655123732220">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p116562037202218">Creation time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0008__p265817372227"><strong id="nosql_06_0008__b1476011515451">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0008__b20762105124511">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_06_0008__row106291337162216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p16598379225">updated</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p1660123712222">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p19661137112210">Update time in the yyyy-MM-ddTHH:mm:ssZ format.</p>
<p id="nosql_06_0008__p136637374223"><strong id="nosql_06_0008__b2890164410467">T</strong> is the separator between calendar and hourly notation of time. <strong id="nosql_06_0008__b28905447467">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="nosql_06_0008__row462920377228"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_06_0008__p96643375226">configuration_parameters</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_06_0008__p6665183752213">Array of <a href="#nosql_06_0008__response_ConfigurationParameterResult">ConfigurationParameterResult</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_06_0008__p15667173716224">Parameters defined by users based on a default parameter template.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="nosql_06_0008__response_ConfigurationParameterResult"></a><a name="response_ConfigurationParameterResult"></a><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0008__response_ConfigurationParameterResult" frame="border" border="1" rules="all"><caption><b>Table 4 </b>ConfigurationParameterResult</caption><thead align="left"><tr id="nosql_06_0008__row11668337202210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.4.2.4.1.1"><p id="nosql_06_0008__p967163711220">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_0008__p867312377220">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_0008__p967433702216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0008__row18668163715225"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p1067503772210">name</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p767619376221">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p176771237102210">Parameter name.</p>
</td>
</tr>
<tr id="nosql_06_0008__row12668103722215"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p13678193713225">value</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p106802372225">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p768118375224">Parameter value.</p>
</td>
</tr>
<tr id="nosql_06_0008__row19669103715229"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p46828374229">restart_required</p>
</td>
<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 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>, 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>
</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>
</td>
<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 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>, 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>
</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>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p19700123714224">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p117011737102217">Value range. For example, the value of the Integer type ranges from <strong id="nosql_06_0008__b422813367489">0</strong> to <strong id="nosql_06_0008__b22292362488">1</strong>, and the value of the Boolean type is <strong id="nosql_06_0008__b17230183614816">true</strong> or <strong id="nosql_06_0008__b12231193610489">false</strong>.</p>
</td>
</tr>
<tr id="nosql_06_0008__row766903712216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p2702133719224">type</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p6703143752217">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p1870453702216">Parameter type. The value can be <strong id="nosql_06_0008__b19852119495">string</strong>, <strong id="nosql_06_0008__b1999821194913">integer</strong>, <strong id="nosql_06_0008__b11101152114916">boolean</strong>, <strong id="nosql_06_0008__b131021721194914">list</strong>, or <strong id="nosql_06_0008__b0103721114918">float</strong>.</p>
</td>
</tr>
<tr id="nosql_06_0008__row12669183752213"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.4.2.4.1.1 "><p id="nosql_06_0008__p20705737142218">description</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.4.2.4.1.2 "><p id="nosql_06_0008__p1770723715225">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.2.4.1.3 "><p id="nosql_06_0008__p1470883782210">Parameter description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0008__section177104373224"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="nosql_06_0008__p14641639152813">URI example<pre class="screen" id="nosql_06_0008__screen39602134018">GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
</div>
</div>
<div class="section" id="nosql_06_0008__section77181537142220"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0008__p8719637122210"><strong id="nosql_06_0008__b53351345144915">Status code: 200</strong></p>
<p id="nosql_06_0008__p197201037142217">Success</p>
<pre class="screen" id="nosql_06_0008__screen9723153712219">{
"id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
"name" : "default-cassandra-3.11",
"datastore_version_name" : "3.11",
"datastore_name" : "cassandra",
"description" : "Default parameter group for cassandra 3.11",
"created" : "2020-03-21T04:40:51+0800",
"updated" : "2020-03-21T04:40:51+0800",
"configuration_parameters" : [ {
"name" : "concurrent_reads",
"value" : "64",
"restart_required" : true,
"readonly" : true,
"value_range" : "4-512",
"type" : "integer",
"description" : "Number of concurrent read threads."
} ]
}</pre>
</div>
<div class="section" id="nosql_06_0008__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0008__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0008__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0008__listapiversion_p1265915205719">For details, see <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</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