forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
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>
143 lines
17 KiB
HTML
143 lines
17 KiB
HTML
<a name="EN-US_TOPIC_0000001917290728"></a><a name="EN-US_TOPIC_0000001917290728"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Parameters of a Specified DB Instance</h1>
|
|
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section563650143816"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p159487012381">This API is used to modify parameters in the parameter template of a specified DB instance. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section1461493103419"><h4 class="sectiontitle">Constraints</h4><ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul13964406388"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li79648019388">The values of the modified parameters must be within the default value range of the specified database version. For details about the value range of parameters, see "Modifying Parameters in a Parameter Template" in <em id="EN-US_TOPIC_0000001917290728__i68871644113216"><span id="EN-US_TOPIC_0000001917290728__text1559788875">GaussDB</span> User Guide</em>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section116519011384"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul159481406386"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li5948150163815">URI format<p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p494814063811"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li5948150163815"></a><a name="en-us_topic_0136489341_li5948150163815"></a>PUT https://{<em id="EN-US_TOPIC_0000001917290728__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1454414211213"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li4411135064210"></a><a name="en-us_topic_0136489341_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li1694811003813">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table156666010383" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row18948107387"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1194880153810"><strong id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.3.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p594815053817"><strong id="EN-US_TOPIC_0000001917290728__b17836020874386">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.64999999999999%" id="mcps1.3.3.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p394813018383"><strong id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row2948130153820"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p129488015381">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p29482006386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1594814073813">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001917290728__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row17948707388"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1094811012382">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.3.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p4948205386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.64999999999999%" headers="mcps1.3.3.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p194814033815">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section37136013381"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul2096411013810"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li9964307381">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table17301053815" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row17964120113817"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1296414014382"><strong id="EN-US_TOPIC_0000001917290728__b1853335601">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.150000000000002%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p119641902388"><strong id="EN-US_TOPIC_0000001917290728__b19338444884386">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p14964140103819"><strong id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.730000000000004%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1596410023814"><strong id="EN-US_TOPIC_0000001917290728__b1036902733">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row7964102380"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p179641309380">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.150000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p169644053814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p09646073812">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p09641305389">Parameter values defined by users based on a default parameter template For details, see <a href="#EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table12745180163820">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table12745180163820"></a><a name="en-us_topic_0136489341_table12745180163820"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table12745180163820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>values field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row19643018386"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p896413010389"><strong id="EN-US_TOPIC_0000001917290728__b1611501640">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.349999999999998%" id="mcps1.3.4.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p149647093818"><strong id="EN-US_TOPIC_0000001917290728__b19912009314386">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1096416010381"><strong id="EN-US_TOPIC_0000001917290728__b2025641998">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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1964150113810"><strong id="EN-US_TOPIC_0000001917290728__b684185315">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row696470153811"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p17964130193815">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1096417018381">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p19642053818">Parameter name. For example, for the <strong id="EN-US_TOPIC_0000001917290728__b1597215596343">"failed_login_attempts": "4"</strong> parameter, the key is <strong id="EN-US_TOPIC_0000001917290728__b1255606183510">failed_login_attempts</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row1196415053814"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p696411018385">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p9964401383">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_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="EN-US_TOPIC_0000001917290728__p187310352614">Parameter value. For example, for the <strong id="EN-US_TOPIC_0000001917290728__b1352505253518">"failed_login_attempts": "4"</strong> parameter, the value is <strong id="EN-US_TOPIC_0000001917290728__b652525263515">4</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul8964605381"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li16964100133819">Example request<pre class="codeblock" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_codeblock139647063814">{
|
|
"values": {
|
|
"<em id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_i135091657151315">xxx</em>": "10",
|
|
"<em id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_i492814041414">yyy</em>": "OFF"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section77762093812"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul11964501387"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li1596420173819">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_table1477614093818" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row6964308384"><th align="left" class="cellrowborder" valign="top" width="25.509999999999998%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p1096410017380"><strong id="EN-US_TOPIC_0000001917290728__b666874708">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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p129648023816"><strong id="EN-US_TOPIC_0000001917290728__b297542138">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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p169647014384"><strong id="EN-US_TOPIC_0000001917290728__b1930923830">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_row096412073812"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_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="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_p0964100183811">Whether a reboot is required.</p>
|
|
<ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_ul896417073811"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li13964170183816"><strong id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_b842352706174226">true</strong>: A reboot is required.</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li179641703387"><strong id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_b842352706174241">false</strong>: A reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li2203123217153">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_codeblock296470103817">{
|
|
"restart_required": false
|
|
}</pre>
|
|
</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li20408118173316">Abnormal response<p id="EN-US_TOPIC_0000001917290728__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_li20408118173316"></a><a name="en-us_topic_0136489341_li20408118173316"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290728__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290728__en-us_topic_0136489341_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290728__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_1023.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|