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>
144 lines
12 KiB
HTML
144 lines
12 KiB
HTML
<a name="rds_05_0024"></a><a name="rds_05_0024"></a>
|
|
|
|
<h1 class="topictitle1">Upgrading the Minor Version of a DB Instance</h1>
|
|
<div id="body0000001575992781"><div class="section" id="rds_05_0024__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_05_0024__p5753583532">This API is used to upgrade minor versions of RDS for MySQL or RDS for PostgreSQL instances.</p>
|
|
<ul id="rds_05_0024__en-us_topic_0238844975_ul12259155218373"><li id="rds_05_0024__en-us_topic_0238844975_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_05_0024__en-us_topic_0238844975_en-us_topic_0110967248_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_05_0024__section13341536702"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0024__ul1455817254417"><li id="rds_05_0024__li3378133924120">This API is available to RDS for MySQL and RDS for PostgreSQL only.</li><li id="rds_05_0024__li137853974110">The minor versions of any RDS for PostgreSQL instances containing abnormal nodes cannot be upgraded.</li><li id="rds_05_0024__li1916705313244">For RDS for PostgreSQL, minor versions can be upgraded immediately upon request submission only, but not during the specified maintenance window.</li><li id="rds_05_0024__li6853953183813">A minor version upgrade of RDS for PostgreSQL instances can cause a primary/standby switchover.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0024__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0024__ul53354139141429"><li id="rds_05_0024__li1270098217262">URI format<p id="rds_05_0024__p66079617141421"><a name="rds_05_0024__li1270098217262"></a><a name="li1270098217262"></a>POST /v3/{project_id}/instances/{instance_id}/db-upgrade</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0024__ul49831254144655"><li id="rds_05_0024__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0024__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0024__row60083059"><th align="left" class="cellrowborder" valign="top" width="20.979999999999997%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_05_0024__p34889605"><strong id="rds_05_0024__b1490842412421">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.55%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_05_0024__p7485743"><strong id="rds_05_0024__b15250404424">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_05_0024__p2365466"><strong id="rds_05_0024__b037315419428">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0024__row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0024__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0024__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0024__p28182251">Project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0024__p181691757183820">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_05_0024__row2864326155157"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0024__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0024__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0024__p981962520456">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0024__section3074340117316"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0024__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_05_0024__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_05_0024__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_05_0024__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_05_0024__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_05_0024__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0024__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0024__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_05_0024__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0024__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0024__p35111331332">The content type.</p>
|
|
<p id="rds_05_0024__p1351133311330">The default value is <strong id="rds_05_0024__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0024__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0024__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_05_0024__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0024__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0024__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_05_0024__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_05_0024__table11236435" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="rds_05_0024__row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_05_0024__p17490046"><strong id="rds_05_0024__b4921202911446">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_05_0024__p7407659"><strong id="rds_05_0024__b12338531154414">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_05_0024__p63149496"><strong id="rds_05_0024__b758193317446">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_05_0024__p14835533"><strong id="rds_05_0024__b78551434174420">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0024__row1585717246378"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_05_0024__p17271157172617">is_delayed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_05_0024__p1027113718260">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_05_0024__p227177162618">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_05_0024__p118580246371">Whether to delay the upgrade until the maintenance window. Valid values:</p>
|
|
<ul id="rds_05_0024__ul3486102803813"><li id="rds_05_0024__li3467518124616"><strong id="rds_05_0024__b174301726202810">true</strong>: The upgrade will be delayed. The instance will be upgraded during the specified maintenance window.</li><li id="rds_05_0024__li15737175462611"><strong id="rds_05_0024__b5437029144015">false</strong> (default): The instance is upgraded immediately.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_05_0024__section36331514477"><h4 class="sectiontitle">Example Request</h4><p id="rds_05_0024__p997104410473">Upgrade the minor version of a DB instance.</p>
|
|
<pre class="screen" id="rds_05_0024__screen1115380154810">POST https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/db-upgrade
|
|
|
|
{
|
|
"is_delayed" : false
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_05_0024__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0024__ul12573920"><li id="rds_05_0024__li16881840172715">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0024__table668693854710" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0024__row579917386473"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_05_0024__p11799738114718"><strong id="rds_05_0024__b3958554122612">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_05_0024__p879983818477"><strong id="rds_05_0024__b74571713279">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_05_0024__p1799538174710"><strong id="rds_05_0024__b187831780274">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0024__row1379923812473"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_05_0024__p5799103874712">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_05_0024__p879983854715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_05_0024__p177991438194711">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_05_0024__li14589114972719">Example normal response<pre class="screen" id="rds_05_0024__screen205311299427">{
|
|
"job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94"
|
|
}</pre>
|
|
</li><li id="rds_05_0024__li68218279114">Abnormal response<p id="rds_05_0024__p28475059"><a name="rds_05_0024__li68218279114"></a><a name="li68218279114"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0024__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0024__rds_01_0002_en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0024__rds_01_0002_en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0024__rds_01_0002_en-us_topic_0032347778_p1040982941020"><a name="rds_05_0024__rds_01_0002_en-us_topic_0032347778_li58581622171411"></a><a name="rds_01_0002_en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_05_0024__rds_01_0002_en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0024__rds_01_0002_en-us_topic_0032347778_p0723374409"><a name="rds_05_0024__rds_01_0002_en-us_topic_0032347778_li11583183218149"></a><a name="rds_01_0002_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_05_0024__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0024__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="en-us_topic_0056887470.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|