forked from docs/doc-exports
Ru, Li Yi
9d8047332b
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>
115 lines
13 KiB
HTML
115 lines
13 KiB
HTML
<a name="rds_19_0002"></a><a name="rds_19_0002"></a>
|
|
|
|
<h1 class="topictitle1">Performing a Major Version Upgrade Pre-Check for a DB Instance (RDS for PostgreSQL)</h1>
|
|
<div id="body0000001990113105"><div class="section" id="rds_19_0002__en-us_topic_0000001718281418_section1445214914388"><h4 class="sectiontitle">Function</h4><p id="rds_19_0002__en-us_topic_0000001718281418_p1753912914388">This API is used to perform a health check before a major version upgrade.</p>
|
|
<ul id="rds_19_0002__ul16405173211918"><li id="rds_19_0002__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_19_0002__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_19_0002__en-us_topic_0000001718281418_section7452496389"><h4 class="sectiontitle">Constraints</h4><ul id="rds_19_0002__en-us_topic_0000001718281418_ul553979183820"><li id="rds_19_0002__en-us_topic_0000001718281418_li185391692381">This API is available to RDS for PostgreSQL only.</li><li id="rds_19_0002__en-us_topic_0000001718281418_li105391794384">This operation cannot be performed when the DB instance is in any of the following statuses: creating, changing instance specifications, changing port, frozen, or abnormal.</li><li id="rds_19_0002__li1347961715304">Major version upgrades are available to the following versions:<ul id="rds_19_0002__ul14404121863013"><li id="rds_19_0002__li14269152120307">RDS for PostgreSQL 12: 12.7 or later</li><li id="rds_19_0002__li07831119142918">RDS for PostgreSQL 13: 13.3 or later</li><li id="rds_19_0002__li121051520124511">RDS for PostgreSQL 14: 14.4 or later</li><li id="rds_19_0002__li733653516126">Major version upgrades are unavailable to RDS for PostgreSQL 11.</li></ul>
|
|
</li><li id="rds_19_0002__en-us_topic_0000001551538538_li16783151902912">Due to OS restrictions, some instances do not support major version upgrades. To learn which versions your instance can be upgraded to, see the list of available versions on the <a href="rds_19_0001.html">Querying the Target Version to Which a DB Instance Can Be Upgraded (RDS for PostgreSQL)</a>.</li><li id="rds_19_0002__en-us_topic_0000001551538538_li778431917297">Before a major version upgrade, perform an upgrade check. If there is no successful upgrade check in the validity period, a major version upgrade is not allowed.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0002__en-us_topic_0000001718281418_section164541194389"><h4 class="sectiontitle">URI</h4><ul id="rds_19_0002__en-us_topic_0000001718281418_ul6539169193816"><li id="rds_19_0002__en-us_topic_0000001718281418_li11539159163812">URI format<p id="rds_19_0002__en-us_topic_0000001718281418_p95391999384"><a name="rds_19_0002__en-us_topic_0000001718281418_li11539159163812"></a><a name="en-us_topic_0000001718281418_li11539159163812"></a>POST /v3/{project_id}/instances/{instance_id}/major-version/inspection</p>
|
|
</li><li id="rds_19_0002__en-us_topic_0000001718281418_li135391991385">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0002__en-us_topic_0000001718281418_table24563963812" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_19_0002__en-us_topic_0000001718281418_row185391894383"><th align="left" class="cellrowborder" valign="top" width="18.560000000000002%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="rds_19_0002__en-us_topic_0000001718281418_p05391915386"><strong id="rds_19_0002__b842352706102328_3">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.46%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="rds_19_0002__en-us_topic_0000001718281418_p20539169153810"><strong id="rds_19_0002__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.46%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="rds_19_0002__en-us_topic_0000001718281418_p7539169143819"><strong id="rds_19_0002__b7772151810541">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50.52000000000001%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="rds_19_0002__en-us_topic_0000001718281418_p4539149143811"><strong id="rds_19_0002__b842352706163417_3">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0002__en-us_topic_0000001718281418_row18539139113813"><td class="cellrowborder" valign="top" width="18.560000000000002%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0002__en-us_topic_0000001718281418_p7539129133811">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.46%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0002__en-us_topic_0000001718281418_p105392916387">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.46%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0002__en-us_topic_0000001718281418_p4539590386">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.52000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0002__p1434580163733">Project ID of a tenant in a region.</p>
|
|
<p id="rds_19_0002__en-us_topic_0000001718281418_p1539149153815">To obtain it, refer to <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0002__en-us_topic_0000001718281418_row195391092389"><td class="cellrowborder" valign="top" width="18.560000000000002%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0002__en-us_topic_0000001718281418_p55395973816">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.46%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0002__en-us_topic_0000001718281418_p17540189193820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.46%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0002__en-us_topic_0000001718281418_p135409915384">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50.52000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0002__en-us_topic_0000001718281418_p95409913383">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0002__en-us_topic_0000001718281418_section54652913811"><h4 class="sectiontitle">Request</h4><ul id="rds_19_0002__en-us_topic_0000001718281418_ul354019923812"><li id="rds_19_0002__en-us_topic_0000001718281418_li4540994383">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0002__en-us_topic_0000001718281418_table2046716943817" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_19_0002__en-us_topic_0000001718281418_row254014912380"><th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_19_0002__en-us_topic_0000001718281418_p105404933817"><strong id="rds_19_0002__b410771855">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.759999999999998%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_19_0002__en-us_topic_0000001718281418_p19540696383"><strong id="rds_19_0002__b521048696">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.98%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_19_0002__p3553193613163"><strong id="rds_19_0002__b1899313405420">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.43%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_19_0002__en-us_topic_0000001718281418_p195401796382"><strong id="rds_19_0002__b1891496684">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0002__en-us_topic_0000001718281418_row15401296389"><td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_19_0002__en-us_topic_0000001718281418_p115408916387">target_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.759999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_19_0002__en-us_topic_0000001718281418_p20540198384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.98%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_19_0002__p3553123619164">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.43%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_19_0002__en-us_topic_0000001718281418_p154020919382">Target version of database.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_19_0002__en-us_topic_0000001718281418_li1354019917385">URI example<pre class="screen" id="rds_19_0002__en-us_topic_0000001718281418_screen726875493911">https://<em id="rds_19_0002__en-us_topic_0000001718281418_i111941819105719">{Endpoint}</em>/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/inspection
|
|
{
|
|
"target_version": "14.9.0"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0002__en-us_topic_0000001718281418_section24721893380"><h4 class="sectiontitle">Response</h4><ul id="rds_19_0002__en-us_topic_0000001718281418_ul1554015913819"><li id="rds_19_0002__en-us_topic_0000001718281418_li4540898389">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0002__en-us_topic_0000001718281418_table1947519923815" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_19_0002__en-us_topic_0000001718281418_row6540179123812"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_19_0002__en-us_topic_0000001718281418_p105401894385"><strong id="rds_19_0002__b1114364772">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27.27272727272727%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_19_0002__en-us_topic_0000001718281418_p954010915389"><strong id="rds_19_0002__b887602053">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.39393939393939%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_19_0002__en-us_topic_0000001718281418_p125401696384"><strong id="rds_19_0002__b1098198087">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0002__en-us_topic_0000001718281418_row85411993815"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0002__en-us_topic_0000001718281418_p2541179163816">report_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27.27272727272727%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0002__en-us_topic_0000001718281418_p95419919384">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.39393939393939%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0002__en-us_topic_0000001718281418_p125418923814">Check report ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_19_0002__en-us_topic_0000001718281418_ul115416973818"><li id="rds_19_0002__en-us_topic_0000001718281418_li1541295383">Example normal response<pre class="screen" id="rds_19_0002__en-us_topic_0000001718281418_screen633452164012">{
|
|
"report_id": "f7a8e35e-a14c-4e5e-b1f0-d3764e8ed8a8"
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="rds_19_0002__en-us_topic_0000001718281418_ul054169143818"><li id="rds_19_0002__en-us_topic_0000001718281418_li25416914382">Abnormal response<p id="rds_19_0002__en-us_topic_0000001718281418_p1454119912388"><a name="rds_19_0002__en-us_topic_0000001718281418_li25416914382"></a><a name="en-us_topic_0000001718281418_li25416914382"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_19_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_19_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_19_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_19_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_19_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_19_0002__en-us_topic_0032347778_p0723374409"><a name="rds_19_0002__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_19_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_19_0002__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_19_0000.html">Upgrading a Major Version</a></div>
|
|
</div>
|
|
</div>
|
|
|