doc-exports/docs/rds/api-ref/rds_19_0001.html
Ru, Li Yi 9d8047332b rds_api
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>
2024-10-10 10:46:10 +00:00

90 lines
11 KiB
HTML

<a name="rds_19_0001"></a><a name="rds_19_0001"></a>
<h1 class="topictitle1">Querying the Target Version to Which a DB Instance Can Be Upgraded (RDS for PostgreSQL)</h1>
<div id="body0000001989993297"><div class="section" id="rds_19_0001__en-us_topic_0000001766001233_section101471329163720"><h4 class="sectiontitle">Function</h4><p id="rds_19_0001__en-us_topic_0000001766001233_p1021482973717">This API is used to query the target version to which an RDS for PostgreSQL DB instance can be upgraded.</p>
<ul id="rds_19_0001__ul16405173211918"><li id="rds_19_0001__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_0001__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_0001__en-us_topic_0000001766001233_section1814882993710"><h4 class="sectiontitle">Constraints</h4><ul id="rds_19_0001__en-us_topic_0000001766001233_ul192141329173714"><li id="rds_19_0001__en-us_topic_0000001766001233_li42141429173719">This API is available to RDS for PostgreSQL only.</li><li id="rds_19_0001__en-us_topic_0000001766001233_li16214112910371">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_0001__li1347961715304">Major version upgrades are available to the following versions:<ul id="rds_19_0001__ul14404121863013"><li id="rds_19_0001__li14269152120307">RDS for PostgreSQL 12: 12.7 or later</li><li id="rds_19_0001__li07831119142918">RDS for PostgreSQL 13: 13.3 or later</li><li id="rds_19_0001__li121051520124511">RDS for PostgreSQL 14: 14.4 or later</li><li id="rds_19_0001__li733653516126">Major version upgrades are unavailable to RDS for PostgreSQL 11.</li></ul>
</li><li id="rds_19_0001__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_0001__en-us_topic_0000001766001233_section181492029183712"><h4 class="sectiontitle">URI</h4><ul id="rds_19_0001__en-us_topic_0000001766001233_ul42141729113719"><li id="rds_19_0001__en-us_topic_0000001766001233_li13214929203710">URI format<p id="rds_19_0001__en-us_topic_0000001766001233_p1221412293370"><a name="rds_19_0001__en-us_topic_0000001766001233_li13214929203710"></a><a name="en-us_topic_0000001766001233_li13214929203710"></a>GET /v3/{project_id}/instances/{instance_id}/major-version/available-version</p>
</li><li id="rds_19_0001__en-us_topic_0000001766001233_li13214192911378">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0001__en-us_topic_0000001766001233_table19150102913371" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_19_0001__en-us_topic_0000001766001233_row72141429153718"><th align="left" class="cellrowborder" valign="top" width="18.56185618561856%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="rds_19_0001__en-us_topic_0000001766001233_p621442913373"><strong id="rds_19_0001__b1544145641918">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.491649164916492%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="rds_19_0001__en-us_topic_0000001766001233_p421452916379"><strong id="rds_19_0001__b89082037102316">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.491649164916492%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="rds_19_0001__en-us_topic_0000001766001233_p0214929113714"><strong id="rds_19_0001__b1881155721914">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.45484548454845%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="rds_19_0001__en-us_topic_0000001766001233_p321482918375"><strong id="rds_19_0001__b459275712195">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_19_0001__en-us_topic_0000001766001233_row1321410293370"><td class="cellrowborder" valign="top" width="18.56185618561856%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0001__en-us_topic_0000001766001233_p17214129103714">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.491649164916492%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0001__en-us_topic_0000001766001233_p19214152973718">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.491649164916492%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0001__en-us_topic_0000001766001233_p2214192923712">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.45484548454845%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0001__p1434580163733">Project ID of a tenant in a region.</p>
<p id="rds_19_0001__en-us_topic_0000001766001233_p2021516295378">To obtain it, refer to <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="rds_19_0001__en-us_topic_0000001766001233_row14215629183717"><td class="cellrowborder" valign="top" width="18.56185618561856%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0001__en-us_topic_0000001766001233_p4215182910372">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.491649164916492%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0001__en-us_topic_0000001766001233_p122158293371">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.491649164916492%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0001__en-us_topic_0000001766001233_p1021522918376">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="48.45484548454845%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0001__en-us_topic_0000001766001233_p1021512933713">Instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_19_0001__en-us_topic_0000001766001233_section1815992953715"><h4 class="sectiontitle">Request</h4><ul id="rds_19_0001__en-us_topic_0000001766001233_ul12215829163714"><li id="rds_19_0001__en-us_topic_0000001766001233_li16215132973717">Request parameters<p id="rds_19_0001__en-us_topic_0000001766001233_p8215142916372"><a name="rds_19_0001__en-us_topic_0000001766001233_li16215132973717"></a><a name="en-us_topic_0000001766001233_li16215132973717"></a>None</p>
</li><li id="rds_19_0001__en-us_topic_0000001766001233_li1421522916371">Example<pre class="screen" id="rds_19_0001__en-us_topic_0000001766001233_screen13327154113400">https://<em id="rds_19_0001__en-us_topic_0000001766001233_i31171851184010">{Endpoint}</em>/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/available-version</pre>
</li></ul>
</div>
<div class="section" id="rds_19_0001__en-us_topic_0000001766001233_section1716122983711"><h4 class="sectiontitle">Response</h4><ul id="rds_19_0001__en-us_topic_0000001766001233_ul421552923714"><li id="rds_19_0001__en-us_topic_0000001766001233_li18215829133711">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0001__en-us_topic_0000001766001233_table1716332943710" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_19_0001__en-us_topic_0000001766001233_row122154299371"><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_0001__en-us_topic_0000001766001233_p021532983718"><strong id="rds_19_0001__b26043094">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_0001__en-us_topic_0000001766001233_p1921562943717"><strong id="rds_19_0001__b182219552">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_0001__en-us_topic_0000001766001233_p19215152914377"><strong id="rds_19_0001__b1842119108">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_19_0001__en-us_topic_0000001766001233_row14215182953711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0001__en-us_topic_0000001766001233_p92151229143713">available_versions</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_0001__en-us_topic_0000001766001233_p521562993719">Array of Strings</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_0001__en-us_topic_0000001766001233_p1821516299374">Available versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_19_0001__en-us_topic_0000001766001233_ul62151291374"><li id="rds_19_0001__en-us_topic_0000001766001233_li15215142919371">Example normal response<pre class="screen" id="rds_19_0001__en-us_topic_0000001766001233_screen35476317416">{
"available_versions": ["13.9", "14.4"]
}</pre>
</li></ul>
<ul id="rds_19_0001__en-us_topic_0000001766001233_ul16216929103718"><li id="rds_19_0001__en-us_topic_0000001766001233_li321632923716">Abnormal response<p id="rds_19_0001__en-us_topic_0000001766001233_p112161129143714"><a name="rds_19_0001__en-us_topic_0000001766001233_li321632923716"></a><a name="en-us_topic_0000001766001233_li321632923716"></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_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_19_0001__en-us_topic_0032347778_ul7858132212142"><li id="rds_19_0001__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_19_0001__en-us_topic_0032347778_p1040982941020"><a name="rds_19_0001__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_19_0001__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_19_0001__en-us_topic_0032347778_p0723374409"><a name="rds_19_0001__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_0001__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_19_0001__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>