doc-exports/docs/rds/api-ref/en-us_topic_0034973639.html
Wang , Deng Ke 5208dcae7b RDS API 20221104 version
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>
2022-11-10 09:55:48 +00:00

86 lines
8.2 KiB
HTML

<a name="en-us_topic_0034973639"></a><a name="en-us_topic_0034973639"></a>
<h1 class="topictitle1">Resetting Parameters to Their Default Values</h1>
<div id="body1470378083916"><div class="section" id="en-us_topic_0034973639__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034973639__p3631239417316">This API is used to reset parameters of a specified DB instance to their default values.</p>
</div>
<div class="section" id="en-us_topic_0034973639__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034973639__ul3084351717316"><li id="en-us_topic_0034973639__li915620217316">URI format<p id="en-us_topic_0034973639__p5364384145046"><a name="en-us_topic_0034973639__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/instances/{nodeId}/parameters/default</p>
<p id="en-us_topic_0034973639__p53716283154824">Method: PUT</p>
</li><li id="en-us_topic_0034973639__li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973639__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973639__row60083059"><th align="left" class="cellrowborder" valign="top" width="20.36%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034973639__p34889605"><strong id="en-us_topic_0034973639__b84235270691445_1">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.2%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034973639__p7485743"><strong id="en-us_topic_0034973639__b842352706102346_1">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50.44%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034973639__p2365466"><strong id="en-us_topic_0034973639__b842352706163417_1">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973639__row57385070"><td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034973639__p17679057">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034973639__p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034973639__p53254067163252">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="en-us_topic_0034973639__row2864326155157"><td class="cellrowborder" valign="top" width="20.36%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034973639__p41557789155220">nodeId</p>
</td>
<td class="cellrowborder" valign="top" width="29.2%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034973639__p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034973639__p7417132564016">Specifies the primary node ID of the DB instance.</p>
<div class="note" id="en-us_topic_0034973639__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0034973639__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_0034973639__li42049266151855">Restrictions<ul id="en-us_topic_0034973639__ul1015345520447"><li id="en-us_topic_0034973639__li15987154911441">If a parameter of the primary DB instance is reset to the default value, the corresponding parameter of the standby DB instance is reset to the default setting simultaneously. You cannot reset the parameters of the standby DB instance to their default values. You can reset the parameters of read replicas to their default values.</li></ul>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034973639__section3074340117316"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0034973639__p718753317316">{}</p>
<p id="en-us_topic_0034973639__p196171211172019">Note: Curly brackets {} indicate that the API does not obtain the data in the request body.</p>
</div>
<div class="section" id="en-us_topic_0034973639__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034973639__ul5601340173158"><li id="en-us_topic_0034973639__li50412063173158">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973639__table37703499173158" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973639__row66334950173158"><th align="left" class="cellrowborder" valign="top" width="27.500000000000004%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034973639__p4421832173158"><strong id="en-us_topic_0034973639__b84235270691445_5">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034973639__p22624127173158"><strong id="en-us_topic_0034973639__b842352706164541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.25%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034973639__p20615027173158"><strong id="en-us_topic_0034973639__b842352706163417_5">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973639__row59204491173158"><td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973639__p30834480173158">shouldRestart</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973639__p14564937173158">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.25%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973639__p13250943137">Indicates whether the parameter needs to be restarted for the modifications to take effect.</p>
<ul id="en-us_topic_0034973639__ul342717448317"><li id="en-us_topic_0034973639__li510315475318">The value <strong id="en-us_topic_0034973639__b1757161015273">1</strong> indicates that the parameter needs to be restarted for the modifications to take effect.</li><li id="en-us_topic_0034973639__li174276445316">The value <strong id="en-us_topic_0034973639__b14865131312276">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_0034973639__row14638904173158"><td class="cellrowborder" valign="top" width="27.500000000000004%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973639__p44900547173158">setParameteResult</p>
</td>
<td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973639__p13065695173158">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.25%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973639__p193406491335">Indicates the parameter modification result.</p>
<ul id="en-us_topic_0034973639__ul16867105018312"><li id="en-us_topic_0034973639__li78332531310">The value <strong id="en-us_topic_0034973639__b18739171512711">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_0034973639__li2867195015318"><strong id="en-us_topic_0034973639__b17571161618271">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_0034973639__ul1226458173158"><li id="en-us_topic_0034973639__li11038126173158">Response example<pre class="codeblock" id="en-us_topic_0034973639__codeblock60848624113746">{
"shouldRestart": "1",
"setParameteResult": "0"
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034973639__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034973639__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>