forked from docs/doc-exports
Wang , Deng Ke
5208dcae7b
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
143 lines
14 KiB
HTML
143 lines
14 KiB
HTML
<a name="rds_09_0303"></a><a name="rds_09_0303"></a>
|
|
|
|
<h1 class="topictitle1">Modifying a Parameter Template</h1>
|
|
<div id="body1540261086867"><div class="section" id="rds_09_0303__section29151894373"><h4 class="sectiontitle">Function</h4><p id="rds_09_0303__p416512103376">This API is used to modify a specified parameter template, including the name, description, and values of specified parameters in the parameter template.</p>
|
|
<ul id="rds_09_0303__ul12259155218373"><li id="rds_09_0303__en-us_topic_0032347778_li1475214752813">Learn how to <a href="rds_03_0001.html">authorize and authenticate</a> this API before using it.</li><li id="rds_09_0303__en-us_topic_0032347778_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section13115202083319"><h4 class="sectiontitle">Constraints</h4><ul id="rds_09_0303__ul20168101873215"><li id="rds_09_0303__en-us_topic_0224329879_li115956617312">The following DB engines are supported: MySQL, PostgreSQL, and Microsoft SQL Server.</li><li id="rds_09_0303__en-us_topic_0224329879_li159610611316">For Microsoft SQL Server, only the following editions are supported: Microsoft SQL Server 2014 SE, 2016 SE, and 2016 EE.</li></ul>
|
|
<ul id="rds_09_0303__ul416501010377"><li id="rds_09_0303__li11165111053720">The modified parameter template name must be different from the name of an existing or a default parameter template. Default parameter templates cannot be modified.</li><li id="rds_09_0303__li9165181018372">The values of the edited parameters must be within the default value range of the specified database version. For details about the range of parameter values, see the "Modifying Parameters in a Parameter Template" section in the <em id="rds_09_0303__i842352697205034">Relational Database Service User Guide</em>.</li><li id="rds_09_0303__li773034814376">The parameter values to be changed cannot be left blank at the same time.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section159150933715"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0303__ul101653103379"><li id="rds_09_0303__li1216521012374">URI format<p id="rds_09_0303__p9165151020373"><a name="rds_09_0303__li1216521012374"></a><a name="li1216521012374"></a>PUT https://{<em id="rds_09_0303__i66262591615">Endpoint</em>}/v3/{<em id="rds_09_0303__i94964418507">project_id</em>}/configurations/{config_id}</p>
|
|
</li><li id="rds_09_0303__li4411135064210">Example<p id="rds_09_0303__p1454414211213"><a name="rds_09_0303__li4411135064210"></a><a name="li4411135064210"></a>https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9</p>
|
|
</li><li id="rds_09_0303__li161651710113716">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0303__table89151953717" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0303__row7165910143717"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="rds_09_0303__p11165161023714"><strong id="rds_09_0303__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.799999999999997%" id="mcps1.3.3.2.3.1.2.4.1.2"><p id="rds_09_0303__p12165121083718"><strong id="rds_09_0303__b960154117330">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.99%" id="mcps1.3.3.2.3.1.2.4.1.3"><p id="rds_09_0303__p11651110153712"><strong id="rds_09_0303__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0303__row17165610153712"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="rds_09_0303__p1416591073710">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="rds_09_0303__p31651810143710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="rds_09_0303__p3165191063718">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0303__p128929918610">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0303__row1316571063716"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="rds_09_0303__p1316511033710">config_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.799999999999997%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="rds_09_0303__p1216561017374">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.99%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="rds_09_0303__p816561014375">Specifies the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section149462918370"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0303__ul216519102371"><li id="rds_09_0303__li16165191013710">Parameter description<div class="notice" id="rds_09_0303__note1984021568"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="rds_09_0303__p12984521269">At least one parameter in the request body must be specified. Otherwise, the request fails to be delivered.</p>
|
|
</div></div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0303__table9962179113713" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0303__row15165121013712"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="rds_09_0303__p616541017372"><strong id="rds_09_0303__b1749898624">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.42%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="rds_09_0303__p15165310143717"><strong id="rds_09_0303__b14646144153315">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="rds_09_0303__p316517107374"><strong id="rds_09_0303__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.730000000000004%" id="mcps1.3.4.2.1.2.2.5.1.4"><p id="rds_09_0303__p19165161013720"><strong id="rds_09_0303__b2057993526">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0303__row1516517104373"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="rds_09_0303__p1116561017377">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.42%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="rds_09_0303__p8165191093712">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="rds_09_0303__p1216591012371">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="rds_09_0303__p9165131016374">Specifies the parameter template name. It contains a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0303__row21651010133713"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="rds_09_0303__p141651310153712">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.42%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="rds_09_0303__p171658107371">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="rds_09_0303__p41651010183710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="rds_09_0303__p1416513103374">Specifies the parameter template description. It contains a maximum of 256 characters and does not support the following special characters: !<>='&" Its value is left blank by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0303__row111655104371"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="rds_09_0303__p21658108374">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.42%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="rds_09_0303__p416513109372">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="rds_09_0303__p6301203614332">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="rds_09_0303__p181657107373">Specifies the parameter values defined by users based on the default parameter template. If this parameter is left blank, the parameter value cannot be changed.</p>
|
|
<p id="rds_09_0303__p17486537123010">For details, see <a href="#rds_09_0303__table597813911376">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0303__table597813911376"></a><a name="table597813911376"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0303__table597813911376" frame="border" border="1" rules="all"><caption><b>Table 3 </b>values field data structure description</caption><thead align="left"><tr id="rds_09_0303__row016541014373"><th align="left" class="cellrowborder" valign="top" width="20.73%" id="mcps1.3.4.2.1.3.2.5.1.1"><p id="rds_09_0303__p8165171013375"><strong id="rds_09_0303__b1850466727">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.500000000000004%" id="mcps1.3.4.2.1.3.2.5.1.2"><p id="rds_09_0303__p13165141083710"><strong id="rds_09_0303__b166925412333">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.040000000000001%" id="mcps1.3.4.2.1.3.2.5.1.3"><p id="rds_09_0303__p7165131053713"><strong id="rds_09_0303__b1074221853">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.730000000000004%" id="mcps1.3.4.2.1.3.2.5.1.4"><p id="rds_09_0303__p20165151033710"><strong id="rds_09_0303__b1686454813">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0303__row516501010377"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="rds_09_0303__p151651710153718">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="rds_09_0303__p141651010113713">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.040000000000001%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="rds_09_0303__p1516541073715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="rds_09_0303__p13165710113715">Specifies the parameter name. For example, in <strong id="rds_09_0303__b84235270621563">"max_connections": "10"</strong>, the key is <strong id="rds_09_0303__b842352706215241">max_connections</strong>. If <strong id="rds_09_0303__b842352706175014">key</strong> is not empty, the parameter <strong id="rds_09_0303__b842352706175018">value</strong> cannot be empty, either.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0303__row116541017376"><td class="cellrowborder" valign="top" width="20.73%" headers="mcps1.3.4.2.1.3.2.5.1.1 "><p id="rds_09_0303__p1916591012374">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.3.4.2.1.3.2.5.1.2 "><p id="rds_09_0303__p21652108377">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.040000000000001%" headers="mcps1.3.4.2.1.3.2.5.1.3 "><p id="rds_09_0303__p516531003715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.3.2.5.1.4 "><p id="rds_09_0303__p11165610133717">Specifies the parameter value. For example, in <strong id="rds_09_0303__b953814020215624">"max_connections": "10"</strong>, the value is <strong id="rds_09_0303__b842352706215633">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0303__ul12165131013710"><li id="rds_09_0303__li12165171023713">Request example<pre class="codeblock" id="rds_09_0303__codeblock816551014379">{
|
|
"name": "configuration_test",
|
|
"description": "configuration_test",
|
|
"values": {
|
|
"max_connections": "10",
|
|
"autocommit": "OFF"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section499319173712"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0303__ul128411207268"><li id="rds_09_0303__li528452016267">Normal response<p id="rds_09_0303__p20721131162610"><a name="rds_09_0303__li528452016267"></a><a name="li528452016267"></a>None</p>
|
|
</li><li id="rds_09_0303__li0990184112610">Abnormal response<p id="rds_09_0303__p1370547123213"><a name="rds_09_0303__li0990184112610"></a><a name="li0990184112610"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="rds_09_0303__en-us_topic_0224329858_p0723374409">For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="rds_09_0303__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0303__en-us_topic_0224329858_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887471.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|