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>
161 lines
14 KiB
HTML
161 lines
14 KiB
HTML
<a name="en-us_topic_0056890264"></a><a name="en-us_topic_0056890264"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Parameters in a Parameter Template</h1>
|
|
<div id="body1492603082526"><div class="section" id="en-us_topic_0056890264__section40938139103438"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0056890264__p809099415819">This API is used to modify parameters in a specified parameter template, including the parameter names, descriptions, and values.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890264__section47568069103438"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0056890264__ul27808384103438"><li id="en-us_topic_0056890264__li48948865103438">URI format<p id="en-us_topic_0056890264__p1052915415827"><a name="en-us_topic_0056890264__li48948865103438"></a><a name="li48948865103438"></a>PATH: /v1.0/{project_id}/configurations/{id}</p>
|
|
<p id="en-us_topic_0056890264__p5435146103438">Method: PUT</p>
|
|
</li><li id="en-us_topic_0056890264__li48916315103438">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890264__table37593651103438" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890264__row58913670103438"><th align="left" class="cellrowborder" valign="top" width="21.05%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0056890264__p7277976103438"><strong id="en-us_topic_0056890264__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.14%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0056890264__p52645207103438"><strong id="en-us_topic_0056890264__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.81%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0056890264__p36403370103438"><strong id="en-us_topic_0056890264__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890264__row62991866103438"><td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890264__p902364145258">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.14%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890264__p5982632145258">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.81%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890264__p14831209145258">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890264__row12926085103438"><td class="cellrowborder" valign="top" width="21.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0056890264__p5797490315835">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.14%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0056890264__p6155576815835">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.81%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0056890264__p5878971515835">Specifies the parameter template ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890264__ul18031397103438"><li id="en-us_topic_0056890264__li28064853103438">Restrictions<ul id="en-us_topic_0056890264__ul30998395195758"><li id="en-us_topic_0056890264__li66028614195757">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="en-us_topic_0056890264__li32901042195757">Currently, the DB engines MySQL and PostgreSQL support modifying parameter templates.</li><li id="en-us_topic_0056890264__li16840232195757">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 section "Modifying Parameters in a Parameter template " in the <em id="en-us_topic_0056890264__i842352697205034">Relational Database Service User Guide</em>.</li><li id="en-us_topic_0056890264__li19114843195757">Parameter template modifications will take effect for DB instances to which the parameter template applies. Some modifications take effect only after the DB instance reboots.</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890264__section53891412103438"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0056890264__ul32156454175656"><li id="en-us_topic_0056890264__li6409747175656">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890264__table3128215103438" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0056890264__row903148103438"><th align="left" class="cellrowborder" valign="top" width="22.56%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0056890264__p6046170103438"><strong id="en-us_topic_0056890264__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.8%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0056890264__p19977801103438"><strong id="en-us_topic_0056890264__b842352706102346_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.69%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0056890264__p7589217103438"><strong id="en-us_topic_0056890264__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.95%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0056890264__p10746825103438"><strong id="en-us_topic_0056890264__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890264__row65186473103438"><td class="cellrowborder" valign="top" width="22.56%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0056890264__p45612970103438">configuration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.8%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0056890264__p3663091103438">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.69%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0056890264__p28274989103438">Dictionary data structure. For details, see <a href="#en-us_topic_0056890264__table23308179103438">Table 3</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.95%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0056890264__p10046338103438">Specifies the parameter template object.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890264__table23308179103438"></a><a name="table23308179103438"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890264__table23308179103438" frame="border" border="1" rules="all"><caption><b>Table 3 </b>configuration field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890264__row46775637103438"><th align="left" class="cellrowborder" valign="top" width="21.62%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="en-us_topic_0056890264__p4159209515175"><strong id="en-us_topic_0056890264__b84235270691445_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.56%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="en-us_topic_0056890264__p3312230415175"><strong id="en-us_topic_0056890264__b842352706102346_7">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.119999999999997%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="en-us_topic_0056890264__p6683254715175"><strong id="en-us_topic_0056890264__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.7%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="en-us_topic_0056890264__p541855815175"><strong id="en-us_topic_0056890264__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890264__row49897329103438"><td class="cellrowborder" valign="top" width="21.62%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0056890264__p2232944215175">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.56%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0056890264__p1476788015175">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0056890264__p3461679815175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.7%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0056890264__p2148036194630">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="en-us_topic_0056890264__row5597748103438"><td class="cellrowborder" valign="top" width="21.62%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0056890264__p3172936115175">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.56%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0056890264__p2605378115175">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0056890264__p3889575015175">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.7%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0056890264__p58088587174823">Specifies the parameter template description. It contains a maximum of 256 characters and does not support the following special characters: !<>='&"</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890264__row36195986103438"><td class="cellrowborder" valign="top" width="21.62%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="en-us_topic_0056890264__p1291584615175">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.56%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="en-us_topic_0056890264__p4230526515175">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.119999999999997%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="en-us_topic_0056890264__p5058006715175">Dictionary data structure. For details, see <a href="#en-us_topic_0056890264__table25655849103438">Table 4</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.7%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="en-us_topic_0056890264__p4038861415175">Specifies the parameter values defined by users based on the default parameter template.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0056890264__table25655849103438"></a><a name="table25655849103438"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0056890264__table25655849103438" frame="border" border="1" rules="all"><caption><b>Table 4 </b>values field data structure description</caption><thead align="left"><tr id="en-us_topic_0056890264__row24203070103438"><th align="left" class="cellrowborder" valign="top" width="21.057894210578944%" id="mcps1.3.3.2.1.3.2.5.1.1"><p id="en-us_topic_0056890264__p6440743151716"><strong id="en-us_topic_0056890264__b84235270691445_9">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23.687631236876314%" id="mcps1.3.3.2.1.3.2.5.1.2"><p id="en-us_topic_0056890264__p18370235151716"><strong id="en-us_topic_0056890264__b842352706102346_9">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.17778222177782%" id="mcps1.3.3.2.1.3.2.5.1.3"><p id="en-us_topic_0056890264__p18748004151716"><strong id="en-us_topic_0056890264__b842352706164541_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.076692330766924%" id="mcps1.3.3.2.1.3.2.5.1.4"><p id="en-us_topic_0056890264__p10716837151716"><strong id="en-us_topic_0056890264__b842352706163417_9">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0056890264__row46344255103438"><td class="cellrowborder" valign="top" width="21.057894210578944%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0056890264__p46777534151716">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.687631236876314%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0056890264__p1638374110283">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.17778222177782%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0056890264__p18273526151716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.076692330766924%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0056890264__p45015520202335">Specifies the parameter name. For example, in <strong id="en-us_topic_0056890264__b84235270621563">"max_connections": "10"</strong>, the key is <strong id="en-us_topic_0056890264__b842352706215241">max_connections</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0056890264__row11109234103438"><td class="cellrowborder" valign="top" width="21.057894210578944%" headers="mcps1.3.3.2.1.3.2.5.1.1 "><p id="en-us_topic_0056890264__p50431049151716">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23.687631236876314%" headers="mcps1.3.3.2.1.3.2.5.1.2 "><p id="en-us_topic_0056890264__p6547859210283">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.17778222177782%" headers="mcps1.3.3.2.1.3.2.5.1.3 "><p id="en-us_topic_0056890264__p66033168151716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.076692330766924%" headers="mcps1.3.3.2.1.3.2.5.1.4 "><p id="en-us_topic_0056890264__p79653202335">Specifies the parameter value. For example, in <strong id="en-us_topic_0056890264__b842352706151346">"max_connections": "10"</strong>, the value is <strong id="en-us_topic_0056890264__b842352706151357">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0056890264__ul45111455103438"><li id="en-us_topic_0056890264__li3349915103438">Request example<pre class="codeblock" id="en-us_topic_0056890264__codeblock38988398103438">{
|
|
"configuration": {
|
|
"name": "configuration_test",
|
|
"description": "configuration_test",
|
|
"values": {
|
|
"max_connections": "10",
|
|
"autocommit": "OFF"
|
|
}
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890264__section15351265103438"><h4 class="sectiontitle">Normal Response</h4><pre class="codeblock" id="en-us_topic_0056890264__codeblock60126205152131">{
|
|
"errCode": "RDS.0041",
|
|
"externalMessage": "Operation accepted success."
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0056890264__section51001047103438"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0056890264__p37444118103438">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0022.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|