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

138 lines
10 KiB
HTML
Raw Blame History

<a name="nosql_06_0004"></a><a name="nosql_06_0004"></a>
<h1 class="topictitle1">Modifying Parameters in a Parameter Template</h1>
<div id="body6782105512105"><div class="section" id="nosql_06_0004__section1078285513104"><h4 class="sectiontitle">Function</h4><p id="nosql_06_0004__p177821355141014">This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.</p>
</div>
<div class="section" id="nosql_06_0004__section485625054612"><h4 class="sectiontitle">Constraints</h4><p id="nosql_06_0004__p3761115274117">This API supports GeminiDB Cassandra instances.</p>
<p id="nosql_06_0004__p136561026114311">The modified parameter template name must be different from the name of any existing or default parameter template.</p>
<p id="nosql_06_0004__p175371228144311">Default parameter templates cannot be modified.</p>
<p id="nosql_06_0004__p17503203044313">For configuration item <strong id="nosql_06_0004__b19621562011">values</strong>, you can enter system-defined parameters that allow for modification.</p>
</div>
<div class="section" id="nosql_06_0004__section1978614557105"><h4 class="sectiontitle">URI</h4><p id="nosql_06_0004__p17867554108">PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__table16788855181016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="nosql_06_0004__row7786175571016"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_06_0004__p6788955141011">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_0004__p1378815556109">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_0004__p9788855141017">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_0004__p9789125511020">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0004__row1078713559106"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0004__p1078935571017">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0004__p4789155511103">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0004__p57901555111018">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0004__p0790125521013">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_0004__row77871955191019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_06_0004__p279015513106">config_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_06_0004__p1879016553104">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_06_0004__p779135551020">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_06_0004__p127911755191011">Parameter template ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0004__section379195510106"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="nosql_06_0004__row27921155121015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_06_0004__p379310552102">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_0004__p079375551014">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_0004__p179315551013">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_0004__p167944556102">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0004__row879275571012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_06_0004__p9794105551012">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_0004__p177941355101016">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_06_0004__p1079595581014">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_06_0004__p147950557100">User token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_06_0004__request_UpdateConfigurationRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_06_0004__row197961355151015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_06_0004__p379775581010">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_0004__p279765551010">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_0004__p6798165517102">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_0004__p57981255131010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="nosql_06_0004__row17796455121017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0004__p19798195512108">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0004__p5798855111012">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0004__p167997551105">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0004__p579905514107">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_0004__row14796155531019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0004__p1579913550100">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0004__p28001155111018">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0004__p68007552103">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_06_0004__p980025531015">Parameter template description. It can include a maximum of 256 characters and cannot contain the following special characters: &gt;!&lt;"&amp;'= The value is left blank by default.</p>
</td>
</tr>
<tr id="nosql_06_0004__row1279625517101"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_06_0004__p6801125516101">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_06_0004__p88011055111014">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_06_0004__p1680195518102">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_0004__p11801145514104">Parameter values defined by users based on a default parameter template. If this parameter is not specified, no parameter values are to be changed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="nosql_06_0004__section4802105541012"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_06_0004__p1823917276130"><strong id="nosql_06_0004__b852863216520">Status code: 200</strong></p>
<p id="nosql_06_0004__p18497183717132">No response parameters</p>
</div>
<div class="section" id="nosql_06_0004__section1080216555109"><h4 class="sectiontitle">Example Requests</h4><ul id="nosql_06_0004__ul168031755121017"><li id="nosql_06_0004__li432617343211">URI example<pre class="screen" id="nosql_06_0004__screen18326434172114">PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06</pre>
</li><li id="nosql_06_0004__li280485519108">Modifying Parameters in a Parameter Template<div class="note" id="nosql_06_0004__note480817557105"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="nosql_06_0004__p58088556108">At least one parameter in the request body must be specified. Otherwise, the request cannot be delivered.</p>
</div></div>
<pre class="screen" id="nosql_06_0004__screen11809175516109">{
"name" : "configuration_test",
"description" : "configuration_test",
"values" : {
"concurrent_reads" : "64"
}
}</pre>
</li></ul>
</div>
<div class="section" id="nosql_06_0004__section158121755141019"><h4 class="sectiontitle">Example Responses</h4><p id="nosql_06_0004__p198131955101018">None</p>
</div>
<div class="section" id="nosql_06_0004__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_06_0004__listapiversion_p201216122353">For details, see <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="nosql_06_0004__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_06_0004__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