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>
114 lines
11 KiB
HTML
114 lines
11 KiB
HTML
<a name="en-us_topic_0034973638"></a><a name="en-us_topic_0034973638"></a>
|
|
|
|
<h1 class="topictitle1">Setting Configuration Parameters</h1>
|
|
<div id="body1470378083916"><div class="section" id="en-us_topic_0034973638__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034973638__p5949244175626">This API is used to set DB instance parameters.</p>
|
|
<div class="note" id="en-us_topic_0034973638__note4760345717423"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="en-us_topic_0034973638__p2577793617423">A parameter template (with same name as the DB instance) will be created if needed.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034973638__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034973638__ul3084351717316"><li id="en-us_topic_0034973638__li915620217316">URI format<p id="en-us_topic_0034973638__p5114783514507"><a name="en-us_topic_0034973638__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/instances/{nodeId}/parameters</p>
|
|
<p id="en-us_topic_0034973638__p4233220154814">Method: PUT</p>
|
|
</li><li id="en-us_topic_0034973638__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973638__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973638__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.490000000000002%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034973638__p34889605"><strong id="en-us_topic_0034973638__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.27%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034973638__p7485743"><strong id="en-us_topic_0034973638__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.239999999999995%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034973638__p2365466"><strong id="en-us_topic_0034973638__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034973638__row57385070"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034973638__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.27%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034973638__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.239999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034973638__p59352878163330">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034973638__row2864326155157"><td class="cellrowborder" valign="top" width="21.490000000000002%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034973638__p41557789155220">nodeId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.27%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034973638__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.239999999999995%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034973638__p7417132564016">Specifies the primary node ID of the DB instance.</p>
|
|
<div class="note" id="en-us_topic_0034973638__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0034973638__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0034973638__li61827782155332">Restrictions<ul id="en-us_topic_0034973638__ul29546242103433"><li id="en-us_topic_0034973638__li79648019388">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="en-us_topic_0034973638__en-us_topic_0224329853_i842352697205034">Relational Database Service User Guide</em>.</li><li id="en-us_topic_0034973638__li57531578103433">If a parameter of the primary DB instance is modified, the corresponding parameter of the standby DB instance is modified simultaneously. You cannot modify the parameters of the standby DB instance. You can modify the parameters of read replicas.</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034973638__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0034973638__ul26059286"><li id="en-us_topic_0034973638__li33206990">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973638__table30427456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973638__row47542385"><th align="left" class="cellrowborder" valign="top" width="21.310000000000002%" id="mcps1.3.3.2.1.1.2.4.1.1"><p id="en-us_topic_0034973638__p25727981"><strong id="en-us_topic_0034973638__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="28.63%" id="mcps1.3.3.2.1.1.2.4.1.2"><p id="en-us_topic_0034973638__p3591713"><strong id="en-us_topic_0034973638__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.06%" id="mcps1.3.3.2.1.1.2.4.1.3"><p id="en-us_topic_0034973638__p22493366"><strong id="en-us_topic_0034973638__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034973638__row10023380"><td class="cellrowborder" valign="top" width="21.310000000000002%" headers="mcps1.3.3.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973638__p6587426">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="28.63%" headers="mcps1.3.3.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973638__p63819464">Dictionary data structure</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.06%" headers="mcps1.3.3.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973638__p17946858">Specifies the parameter value list.</p>
|
|
<p id="en-us_topic_0034973638__p3479331719245"><strong id="en-us_topic_0034973638__b842352706143230">key</strong> specifies the parameter name. <strong id="en-us_topic_0034973638__b842352706143238">value</strong> specifies the parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034973638__ul20834188172515"><li id="en-us_topic_0034973638__li53289967172515">Request example<pre class="codeblock" id="en-us_topic_0034973638__codeblock1161517517584">{
|
|
"values": {
|
|
"connect_timeout": 17,
|
|
"sync_binlog": 1
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034973638__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034973638__ul5601340173158"><li id="en-us_topic_0034973638__li50412063173158">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973638__table37703499173158" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973638__row66334950173158"><th align="left" class="cellrowborder" valign="top" width="27.13%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034973638__p4421832173158"><strong id="en-us_topic_0034973638__b84235270691445_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.99%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034973638__p22624127173158"><strong id="en-us_topic_0034973638__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.88%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034973638__p20615027173158"><strong id="en-us_topic_0034973638__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034973638__row59204491173158"><td class="cellrowborder" valign="top" width="27.13%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973638__p30834480173158">shouldRestart</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973638__p14564937173158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973638__p1227762316311">Indicates whether the parameter needs to be restarted for the modifications to take effect.</p>
|
|
<ul id="en-us_topic_0034973638__ul199728241833"><li id="en-us_topic_0034973638__li12104202917314">The value <strong id="en-us_topic_0034973638__b938895142310">1</strong> indicates that the parameter needs to be restarted for the modifications to take effect.</li><li id="en-us_topic_0034973638__li7972224330">The value <strong id="en-us_topic_0034973638__b88721309259">0</strong> indicates that the parameter does not need to be restarted for the modifications to take effect</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034973638__row14638904173158"><td class="cellrowborder" valign="top" width="27.13%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973638__p44900547173158">setParameteResult</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.99%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973638__p13065695173158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973638__p56315328316">Indicates the parameter modification result.</p>
|
|
<ul id="en-us_topic_0034973638__ul199986321133"><li id="en-us_topic_0034973638__li912333713319">The value <strong id="en-us_topic_0034973638__b84235270693855">1</strong> indicates that the modifications are successful on the primary DB instance but failed on the standby DB instance.</li><li id="en-us_topic_0034973638__li199817320311"><strong id="en-us_topic_0034973638__b1836103413259">0</strong> indicates that the modifications are successful on every DB instance.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034973638__ul1226458173158"><li id="en-us_topic_0034973638__li11038126173158">Response example<pre class="codeblock" id="en-us_topic_0034973638__codeblock39696707113725">{
|
|
"shouldRestart": "0",
|
|
"setParameteResult": "0"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034973638__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034973638__p28475059">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_0017.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|