forked from docs/doc-exports
Wang , Deng Ke
21e968a153
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>
164 lines
14 KiB
HTML
164 lines
14 KiB
HTML
<a name="rds_09_0305"></a><a name="rds_09_0305"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Parameters of a Specified DB Instance</h1>
|
|
<div id="body1540261086867"><div class="section" id="rds_09_0305__section563650143816"><h4 class="sectiontitle">Function</h4><p id="rds_09_0305__p159487012381">This API is used to modify parameters in the parameter template of a specified DB instance.</p>
|
|
<ul id="rds_09_0305__ul12259155218373"><li id="rds_09_0305__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_09_0305__en-us_topic_0240111818_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_0305__section1461493103419"><h4 class="sectiontitle">Constraints</h4><p id="rds_09_0305__p1795812012577">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_0305__en-us_topic_0224329853_i842352697205034">Relational Database Service User Guide</em>.</p>
|
|
|
|
|
|
</div>
|
|
<div class="section" id="rds_09_0305__section116519011384"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0305__ul159481406386"><li id="rds_09_0305__li5948150163815">URI format<p id="rds_09_0305__p494814063811"><a name="rds_09_0305__li5948150163815"></a><a name="li5948150163815"></a>PUT https://{<em id="rds_09_0305__i621031141614">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li><li id="rds_09_0305__li1694811003813">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0305__table156666010383" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0305__row18948107387"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_09_0305__p1194880153810"><strong id="rds_09_0305__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.67%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_09_0305__p594815053817"><strong id="rds_09_0305__b3126164211330">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.12%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_09_0305__p394813018383"><strong id="rds_09_0305__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0305__row2948130153820"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0305__p129488015381">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.67%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0305__p29482006386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.12%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0305__p1594814073813">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0305__p88831119867">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_0305__row17948707388"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0305__p1094811012382">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.67%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0305__p4948205386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.12%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0305__p194814033815">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0305__section37136013381"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0305__ul2096411013810"><li id="rds_09_0305__li9964307381">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0305__table17301053815" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0305__row17964120113817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_09_0305__p1296414014382"><strong id="rds_09_0305__b1825700343">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_09_0305__p119641902388"><strong id="rds_09_0305__b101597427334">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_09_0305__p14964140103819"><strong id="rds_09_0305__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_09_0305__p1596410023814"><strong id="rds_09_0305__b603618804">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0305__row7964102380"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_09_0305__p179641309380">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_09_0305__p169644053814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_09_0305__p09646073812">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_09_0305__p09641305389">Specifies the parameter values defined by users based on the default parameter templates.</p>
|
|
<p id="rds_09_0305__p128891559123615">For details, see <a href="#rds_09_0305__table12745180163820">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0305__table12745180163820"></a><a name="table12745180163820"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0305__table12745180163820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>values field data structure description</caption><thead align="left"><tr id="rds_09_0305__row19643018386"><th align="left" class="cellrowborder" valign="top" width="20.169999999999998%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="rds_09_0305__p896413010389"><strong id="rds_09_0305__b1672634051">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.369999999999997%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="rds_09_0305__p149647093818"><strong id="rds_09_0305__b19184164211339">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.73%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="rds_09_0305__p1096416010381"><strong id="rds_09_0305__b491897444">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_0305__p1964150113810"><strong id="rds_09_0305__b2142018081">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0305__row696470153811"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="rds_09_0305__p17964130193815">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.369999999999997%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="rds_09_0305__p1096417018381">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="rds_09_0305__p4964100163820">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_0305__p19642053818">Specifies the parameter name. For example, in <strong id="rds_09_0305__b84235270621563">"max_connections": "10"</strong>, the key is <strong id="rds_09_0305__b842352706215241">max_connections</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0305__row1196415053814"><td class="cellrowborder" valign="top" width="20.169999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="rds_09_0305__p696411018385">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.369999999999997%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="rds_09_0305__p9964401383">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.73%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="rds_09_0305__p09647018388">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_0305__p209641004383">Specifies the parameter value. For example, in <strong id="rds_09_0305__b953814020215624">"max_connections": "10"</strong>, the value is <strong id="rds_09_0305__b842352706215633">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0305__ul1780819393432"><li id="rds_09_0305__li4411135064210">Example<p id="rds_09_0305__p1454414211213"><a name="rds_09_0305__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0305__ul8964605381"><li id="rds_09_0305__li16964100133819">Request example<pre class="codeblock" id="rds_09_0305__codeblock139647063814">{
|
|
"values": {
|
|
"max_connections": "10",
|
|
"autocommit": "OFF"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0305__section77762093812"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0305__ul11964501387"><li id="rds_09_0305__li1596420173819">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0305__table1477614093818" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0305__row6964308384"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_09_0305__p1096410017380"><strong id="rds_09_0305__b345595144">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.82%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_09_0305__p129648023816"><strong id="rds_09_0305__b392854292">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_09_0305__p169647014384"><strong id="rds_09_0305__b1079786441">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0305__row096412073812"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0305__p896419003819">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0305__p1396417033819">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0305__p0964100183811">Indicates whether a reboot is required.</p>
|
|
<ul id="rds_09_0305__ul896417073811"><li id="rds_09_0305__li13964170183816"><strong id="rds_09_0305__b842352706174226">true</strong>: A reboot is required.</li><li id="rds_09_0305__li179641703387"><strong id="rds_09_0305__b842352706174241">false</strong>: A reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0305__row19805138155710"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0305__p911404113216">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0305__p12114941162119">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0305__p1511414113218">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0305__row7684115111115"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0305__p29871147132715">ignored_params</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.82%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0305__p798715472277">Set<String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0305__p14270103281">List of ignored parameters.</p>
|
|
<p id="rds_09_0305__p127070192813">If a parameter does not exist or is read-only, the parameter cannot be modified and the names of all ignored parameters are returned by <strong id="rds_09_0305__b2418784315">ignored_params</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_09_0305__li2203123217153">Example normal response<pre class="codeblock" id="rds_09_0305__codeblock296470103817">{
|
|
"restart_required": false,
|
|
"job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
|
|
"ignored_params": ["autocommit"]
|
|
}</pre>
|
|
</li><li id="rds_09_0305__li20408118173316">Abnormal Response<p id="rds_09_0305__p3964140153810"><a name="rds_09_0305__li20408118173316"></a><a name="li20408118173316"></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_0305__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0305__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0305__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0305__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0305__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0305__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0305__en-us_topic_0032347778_p0723374409"><a name="rds_09_0305__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0305__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0305__en-us_topic_0032347778_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>
|
|
|