forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
159 lines
14 KiB
HTML
159 lines
14 KiB
HTML
<a name="rds_11_0013"></a><a name="rds_11_0013"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Value of a Specified Parameter for an Instance</h1>
|
|
<div id="body0000002428952760"><div class="section" id="rds_11_0013__en-us_topic_0245436637_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_11_0013__en-us_topic_0245436637_p52780252141331">This API is used to modify the value of a specified parameter for an instance.</p>
|
|
<ul id="rds_11_0013__ul10163594121"><li id="rds_11_0013__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_11_0013__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_11_0013__en-us_topic_0245436637_section102419107473"><h4 class="sectiontitle">Constraints</h4><ul id="rds_11_0013__ul182851057183112"><li id="rds_11_0013__li17285115714311">This operation cannot be performed when the DB instance is in the abnormal state.</li><li id="rds_11_0013__li12910135103213">Parameters of read replicas cannot be modified.</li><li id="rds_11_0013__li16285657203118">Only the value of <strong id="rds_11_0013__b856212376912">shared_preload_libraries</strong> can be modified.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0013__en-us_topic_0245436637_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_11_0013__en-us_topic_0245436637_ul16391217184115"><li id="rds_11_0013__en-us_topic_0245436637_li363951734111">URI format<p id="rds_11_0013__en-us_topic_0245436637_p1363971724110"><a name="rds_11_0013__en-us_topic_0245436637_li363951734111"></a><a name="en-us_topic_0245436637_li363951734111"></a>PUT https://{<em id="rds_11_0013__en-us_topic_0245436637_i1434032491719">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/parameter/{name}</p>
|
|
</li><li id="rds_11_0013__li1165156204511">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0013__en-us_topic_0245436637_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_11_0013__en-us_topic_0245436637_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_11_0013__en-us_topic_0245436637_p34889605"><strong id="rds_11_0013__b157581936192015">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_11_0013__en-us_topic_0245436637_p7485743"><strong id="rds_11_0013__b115913561692">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_11_0013__en-us_topic_0245436637_p2365466"><strong id="rds_11_0013__b694055913917">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0013__en-us_topic_0245436637_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0013__en-us_topic_0245436637_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0013__en-us_topic_0245436637_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0013__en-us_topic_0285677743_en-us_topic_0144420999_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_11_0013__en-us_topic_0285677743_en-us_topic_0144420999_p27281110194">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_11_0013__en-us_topic_0245436637_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0013__en-us_topic_0245436637_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0013__en-us_topic_0245436637_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0013__en-us_topic_0285677743_en-us_topic_0144420999_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0013__row1380322317343"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_11_0013__p188174353414">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_11_0013__p988843153413">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_11_0013__p654613108402">Parameter name.</p>
|
|
<p id="rds_11_0013__p10691102654010">Only the <strong id="rds_11_0013__b10300165515417">shared_preload_libraries</strong> parameter can be modified.</p>
|
|
<p id="rds_11_0013__p72931151193516">The default value is <strong id="rds_11_0013__b1319123145910">shared_preload_libraries</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0013__en-us_topic_0245436637_section3074340117316"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0013__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_11_0013__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_11_0013__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="rds_11_0013__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="rds_11_0013__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="rds_11_0013__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0013__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_11_0013__p18511533163317">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_11_0013__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_11_0013__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_11_0013__p35111331332">The content type.</p>
|
|
<p id="rds_11_0013__p1351133311330">The default value is <strong id="rds_11_0013__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0013__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_11_0013__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_11_0013__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_11_0013__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_11_0013__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_11_0013__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0013__en-us_topic_0245436637_table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_11_0013__en-us_topic_0245436637_row50931783"><th align="left" class="cellrowborder" valign="top" width="20.669999999999998%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_11_0013__en-us_topic_0245436637_p31833731"><strong id="rds_11_0013__b12633145152010">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.09%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_11_0013__en-us_topic_0245436637_p1218491020110"><strong id="rds_11_0013__b1647623151111">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.009999999999998%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_11_0013__en-us_topic_0245436637_p28395444"><strong id="rds_11_0013__b16785124191119">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.230000000000004%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_11_0013__en-us_topic_0245436637_p18329666"><strong id="rds_11_0013__b112173614116">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0013__en-us_topic_0245436637_row8307988"><td class="cellrowborder" valign="top" width="20.669999999999998%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_11_0013__p1133201323511">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.09%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_11_0013__p143391383520">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.009999999999998%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_11_0013__p13371313518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.230000000000004%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_11_0013__p19658134115344">Parameter value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_11_0013__section11637104553018"><h4 class="sectiontitle">Example Request</h4><p id="rds_11_0013__p178781750113011">Change the value of <strong id="rds_11_0013__b9567325347">shared_preload_libraries</strong> for a DB instance.</p>
|
|
<pre class="screen" id="rds_11_0013__screen14201099316">PUT https://rds.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries
|
|
{
|
|
"value" : "passwordcheck.so,pg_stat_statements,pg_sql_history"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_11_0013__en-us_topic_0245436637_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_11_0013__en-us_topic_0245436637_ul12573920"><li id="rds_11_0013__en-us_topic_0245436637_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_11_0013__en-us_topic_0245436637_table32267243" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameters</caption><thead align="left"><tr id="rds_11_0013__en-us_topic_0245436637_row9230088"><th align="left" class="cellrowborder" valign="top" width="27.382738273827385%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_11_0013__en-us_topic_0245436637_p9439626"><strong id="rds_11_0013__b10141659102013">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.122712271227122%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_11_0013__en-us_topic_0245436637_p26412257"><strong id="rds_11_0013__b1981219383124">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.4945494549455%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_11_0013__en-us_topic_0245436637_p59018101"><strong id="rds_11_0013__b1124420409126">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_11_0013__en-us_topic_0245436637_row15736877"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_11_0013__p387034815358">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_11_0013__p168703486354">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_11_0013__p587034853519">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_11_0013__row5726242163518"><td class="cellrowborder" valign="top" width="27.382738273827385%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_11_0013__p10870184843517">restart_required</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.122712271227122%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_11_0013__p987024811356">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.4945494549455%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_11_0013__p1687014812355">Whether a reboot is required. The value can be:</p>
|
|
<ul id="rds_11_0013__ul787010481351"><li id="rds_11_0013__li118708483354"><strong id="rds_11_0013__b19799041201315">true</strong>: indicates that a reboot is required.</li><li id="rds_11_0013__li98701548203516"><strong id="rds_11_0013__b2348144681311">false</strong>: indicates that a reboot is not required.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_11_0013__li10521103115432">Example normal response<pre class="screen" id="rds_11_0013__screen7283315175612">{
|
|
"job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94",
|
|
"restart_required" : true
|
|
}</pre>
|
|
</li><li id="rds_11_0013__li1930710290432">Abnormal response<p id="rds_11_0013__p46896054"><a name="rds_11_0013__li1930710290432"></a><a name="li1930710290432"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_11_0013__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_11_0013__en-us_topic_0032347778_ul7858132212142"><li id="rds_11_0013__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_11_0013__en-us_topic_0032347778_p1040982941020"><a name="rds_11_0013__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_11_0013__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_11_0013__en-us_topic_0032347778_p0723374409"><a name="rds_11_0013__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_11_0013__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_11_0013__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="rds_11_0025.html">Extension Management (RDS for PostgreSQL)</a></div>
|
|
</div>
|
|
</div>
|
|
|