forked from docs/doc-exports
Wang , Deng Ke
a96a12ecf1
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
141 lines
15 KiB
HTML
141 lines
15 KiB
HTML
<a name="opengauss_api_0024"></a><a name="opengauss_api_0024"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Parameters of a Specified DB Instance</h1>
|
|
<div id="body8662426"><div class="section" id="opengauss_api_0024__s2e67cb9a6e0c46b58c77845f1a11cfc6"><h4 class="sectiontitle">Function</h4><p id="opengauss_api_0024__en-us_topic_0136489341_p159487012381">This API is used to modify parameters in the parameter template of a specified DB instance.</p>
|
|
<ul id="opengauss_api_0024__u413fabe9d6424d699b1154bd2f3df8dd"><li id="opengauss_api_0024__en-us_topic_0256709922_li41227910453">Before calling an API, you need to understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="opengauss_api_0024__lb5b27d5b1c7e4fb6aa975d2581fcbcf8">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="opengauss_api_0024__s399f5b2886d948779b351f57e8dc24e2"><h4 class="sectiontitle">Constraints</h4><ul id="opengauss_api_0024__en-us_topic_0136489341_ul13964406388"><li id="opengauss_api_0024__en-us_topic_0136489341_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 "Modifying Parameters in a Parameter Template" in the <em id="opengauss_api_0024__i15391031125819"><span id="opengauss_api_0024__text15769182017719">GaussDB(openGauss)</span> User Guide</em>.</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0024__s4bb950b4c71c4844a7b47dfc668671f5"><h4 class="sectiontitle">URI</h4><ul id="opengauss_api_0024__u60b9900d96c0408fad1e2c1b84633eec"><li id="opengauss_api_0024__l20e9b3d43ccd4624bd713b8fd60ecbe7">URI format<p id="opengauss_api_0024__en-us_topic_0136489341_p494814063811"><a name="opengauss_api_0024__l20e9b3d43ccd4624bd713b8fd60ecbe7"></a><a name="l20e9b3d43ccd4624bd713b8fd60ecbe7"></a>PUT https://{<em id="opengauss_api_0024__a1e43346df0ec495a8184551b098f4628">Endpoint</em>}/opengauss/v3/{project_id}/instances/{instance_id}/configurations</p>
|
|
</li><li id="opengauss_api_0024__le8f06866e82c427281ab2b920ce507b3">Example<p id="opengauss_api_0024__ac34eabbd068e417f89bfd331f79a90f1"><a name="opengauss_api_0024__le8f06866e82c427281ab2b920ce507b3"></a><a name="le8f06866e82c427281ab2b920ce507b3"></a>https://gaussdb.eu-de.otc.t-systems.com/opengauss/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/configurations</p>
|
|
</li><li id="opengauss_api_0024__l034b674ab7374c47b1c4c0ad027f2807">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0024__tfae279f4e7f94bad86730e23483d6972" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0024__rc834124c874c46ff87f472ef9e0687ee"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.3.2.3.1.2.4.1.1"><p id="opengauss_api_0024__a05001a2eac62425c9b8ce8ae951f016b"><strong id="opengauss_api_0024__a159ae7b9318b4af5bc11488709a2f240">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="opengauss_api_0024__en-us_topic_0136489341_p594815053817"><strong>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="opengauss_api_0024__en-us_topic_0136489341_p394813018383"><strong id="opengauss_api_0024__a1d21792d3365402699fcdc5bc2e97a89">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0024__r2800827bf63f42aca0d817295f435e3c"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__a1f0e863f2ff8474bbc1d423cd8fa6780">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="opengauss_api_0024__p8544202712219">For details about how to obtain the project ID, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="opengauss_api_0024__r9611a56a5acc40eeb264ec0ad3e9a82c"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.3.2.3.1.2.4.1.1 "><p id="opengauss_api_0024__a4aba6655e7314416afd398114c752399">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="opengauss_api_0024__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="opengauss_api_0024__en-us_topic_0136489341_p194814033815">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0024__s5f41e268b1b34efd9cadef0fbcbde3da"><h4 class="sectiontitle">Request</h4><ul id="opengauss_api_0024__u92ee985ffa414a9bbfa88efaa9e8b11c"><li id="opengauss_api_0024__en-us_topic_0136489341_li9964307381">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0024__t67b76e4747434c0cae6d8657b0889403" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0024__r6d09c2fa363744bca0d8ec9ea0e553ee"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="opengauss_api_0024__a962f502270d0487f98434ac5e2481ff2"><strong id="opengauss_api_0024__b1244087634">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="opengauss_api_0024__en-us_topic_0136489341_p119641902388"><strong>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="opengauss_api_0024__af7d6ff19594c42a29341ccb5d43eba51"><strong id="opengauss_api_0024__aa3de72d03b39483190be9c5ed58d0d5c">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="opengauss_api_0024__a76ab65da833f439eabf0b38439edc5a4"><strong id="opengauss_api_0024__b166372863">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__en-us_topic_0136489341_p09641305389">Specifies the parameter values defined by users based on the default parameter templates. For details, see <a href="#opengauss_api_0024__t4d55d375227f4efd85a5d345d4eddd2c">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="opengauss_api_0024__t4d55d375227f4efd85a5d345d4eddd2c"></a><a name="t4d55d375227f4efd85a5d345d4eddd2c"></a><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0024__t4d55d375227f4efd85a5d345d4eddd2c" frame="border" border="1" rules="all"><caption><b>Table 3 </b>values field data structure description</caption><thead align="left"><tr id="opengauss_api_0024__r09247b9fec7d48dea5796aebf6330a6b"><th align="left" class="cellrowborder" valign="top" width="24.490000000000002%" id="mcps1.3.4.2.1.2.2.5.1.1"><p id="opengauss_api_0024__en-us_topic_0136489341_p896413010389"><strong id="opengauss_api_0024__b1935816288">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="opengauss_api_0024__en-us_topic_0136489341_p149647093818"><strong>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="opengauss_api_0024__ab0d8fb1586af4271923b3148e089fbfd"><strong id="opengauss_api_0024__b1794353130">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="opengauss_api_0024__a2c840f23916b4d99936b1b66606e2f65"><strong id="opengauss_api_0024__b1913081867">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0024__ra0e54f70c5c54075a82f9de1139f7824"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="opengauss_api_0024__a557015128e19485393cb279f21dbe68b">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.349999999999998%" headers="mcps1.3.4.2.1.2.2.5.1.2 "><p id="opengauss_api_0024__afda9ac1320ac4239b4d36e5bcabcad73">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="opengauss_api_0024__ac029a0f03d7c4754ba3716a2634a268b">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.730000000000004%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="opengauss_api_0024__en-us_topic_0136489341_p19642053818">Specifies the parameter name. For example, for the <strong id="opengauss_api_0024__b1597215596343">"failed_login_attempts": "4"</strong> parameter, the key is <strong id="opengauss_api_0024__b1255606183510">failed_login_attempts</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="opengauss_api_0024__re7a47419818849ca8d9a73b832489387"><td class="cellrowborder" valign="top" width="24.490000000000002%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__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="opengauss_api_0024__p187310352614">Specifies the parameter value. For example, for the <strong id="opengauss_api_0024__b1352505253518">"failed_login_attempts": "4"</strong> parameter, the value is <strong id="opengauss_api_0024__b652525263515">4</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="opengauss_api_0024__en-us_topic_0136489341_ul8964605381"><li id="opengauss_api_0024__l8126cf33107d47ed9e914edf7224a0ea">Request example<pre class="codeblock" id="opengauss_api_0024__c87ca181d519b4bbb88e8b4ca4e702f6a">{
|
|
"values": {
|
|
"<em id="opengauss_api_0024__aaefb59d5dca04cba92d41a45f72ac8c4">xxx</em>": "10",
|
|
"<em id="opengauss_api_0024__en-us_topic_0136489341_i492814041414">yyy</em>": "OFF"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0024__s178b3945eedb4b028d6777ba164cca6f"><h4 class="sectiontitle">Response</h4><ul id="opengauss_api_0024__en-us_topic_0136489341_ul11964501387"><li id="opengauss_api_0024__l5dd3c788493d41c68143a9da2480d250">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="opengauss_api_0024__tec8b5c2902ba41cea35fbc102e433b04" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="opengauss_api_0024__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="opengauss_api_0024__a4dfe1bf8f27e48d2bd2885f87640fffc"><strong id="opengauss_api_0024__b357329425">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="opengauss_api_0024__en-us_topic_0136489341_p129648023816"><strong id="opengauss_api_0024__b1665451083">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="opengauss_api_0024__en-us_topic_0136489341_p169647014384"><strong id="opengauss_api_0024__b2109819634">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="opengauss_api_0024__r00ef4e8a73424d3ab61f05f0c1d864bb"><td class="cellrowborder" valign="top" width="25.509999999999998%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="opengauss_api_0024__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="opengauss_api_0024__a1dd69e13de23425ab26407883a90fb34">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.67%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="opengauss_api_0024__a82ffa5bac6fd410ab6c8c8e903f973cf">Indicates whether a reboot is required.</p>
|
|
<ul id="opengauss_api_0024__uf48648344c7c40f59ee1bf814cbf3785"><li id="opengauss_api_0024__l62a98a3217c34398b12beb4004dfcfe1"><strong id="opengauss_api_0024__ab79a4c0efe1541e080dd7646e185a423">true</strong>: A reboot is required.</li><li id="opengauss_api_0024__l027063bcdaa84e8198b1c7f58ddde810"><strong id="opengauss_api_0024__a9a3165e81a734769a01142efdf1490cb">false</strong>: A reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="opengauss_api_0024__l07e669b09ff9498b90b60f077e5cc533">Example normal response<pre class="codeblock" id="opengauss_api_0024__c2a5f757113344f67b94d776904f211f8">{
|
|
"restart_required": false
|
|
}</pre>
|
|
</li><li id="opengauss_api_0024__l880b6bf0d9ad42d2b27484103f64e7d3">Abnormal response<p id="opengauss_api_0024__a72740c637ef6476e9c3c6e424dbe5aa7"><a name="opengauss_api_0024__l880b6bf0d9ad42d2b27484103f64e7d3"></a><a name="l880b6bf0d9ad42d2b27484103f64e7d3"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0024__sa506eeae9b824320b6f6e87eebbdde24"><h4 class="sectiontitle">Status Codes</h4><p id="opengauss_api_0024__ad6824e04527a4a76a14f3ecaae2eb642">For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="opengauss_api_0024__s1c3d33002b874c6fa198feb2beb40a42"><h4 class="sectiontitle">Error Codes</h4><p id="opengauss_api_0024__a478f17fa76dc42f792612496f9e1fdba">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_0023.html">Parameter Configuration</a></div>
|
|
</div>
|
|
</div>
|
|
|