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>
148 lines
17 KiB
HTML
148 lines
17 KiB
HTML
<a name="rds_19_0003"></a><a name="rds_19_0003"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Major Version Check Status or Upgrade Status of a DB Instance (RDS for PostgreSQL)</h1>
|
|
<div id="body0000001954633944"><div class="section" id="rds_19_0003__en-us_topic_0000001765881997_section1461163652219"><h4 class="sectiontitle">Function</h4><p id="rds_19_0003__en-us_topic_0000001765881997_p0583183611223">This API is used to query the major version check status or upgrade status.</p>
|
|
<ul id="rds_19_0003__ul16405173211918"><li id="rds_19_0003__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_0003__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_0003__en-us_topic_0000001765881997_section046253672213"><h4 class="sectiontitle">Constraints</h4><ul id="rds_19_0003__ul666617117112"><li id="rds_19_0003__li1094262116">This API is available to RDS for PostgreSQL only.</li><li id="rds_19_0003__li1347961715304">Major version upgrades are available to the following versions:<ul id="rds_19_0003__ul14404121863013"><li id="rds_19_0003__li14269152120307">RDS for PostgreSQL 12: 12.7 or later</li><li id="rds_19_0003__li07831119142918">RDS for PostgreSQL 13: 13.3 or later</li><li id="rds_19_0003__li121051520124511">RDS for PostgreSQL 14: 14.4 or later</li><li id="rds_19_0003__li733653516126">Major version upgrades are unavailable to RDS for PostgreSQL 11.</li></ul>
|
|
</li><li id="rds_19_0003__li292611112325">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_0003__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_0003__en-us_topic_0000001765881997_section74651736172214"><h4 class="sectiontitle">URI</h4><ul id="rds_19_0003__en-us_topic_0000001765881997_ul2058313365228"><li id="rds_19_0003__en-us_topic_0000001765881997_li95832367224">URI format<p id="rds_19_0003__en-us_topic_0000001765881997_p10583173617220"><a name="rds_19_0003__en-us_topic_0000001765881997_li95832367224"></a><a name="en-us_topic_0000001765881997_li95832367224"></a>GET /v3/{project_id}/instances/{instance_id}/major-version/status?action={current_action}</p>
|
|
</li><li id="rds_19_0003__en-us_topic_0000001765881997_li8583133614229">Parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0003__en-us_topic_0000001765881997_table1446873616220" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_19_0003__en-us_topic_0000001765881997_row6584143672214"><th align="left" class="cellrowborder" valign="top" width="12.24%" id="mcps1.3.3.2.2.1.2.5.1.1"><p id="rds_19_0003__en-us_topic_0000001765881997_p058416369225"><strong id="rds_19_0003__b1930125715017">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.270000000000001%" id="mcps1.3.3.2.2.1.2.5.1.2"><p id="rds_19_0003__en-us_topic_0000001765881997_p1758483616225"><strong id="rds_19_0003__b917311585018">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.270000000000001%" id="mcps1.3.3.2.2.1.2.5.1.3"><p id="rds_19_0003__en-us_topic_0000001765881997_p1858413612223"><strong id="rds_19_0003__b5890205815011">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.22%" id="mcps1.3.3.2.2.1.2.5.1.4"><p id="rds_19_0003__en-us_topic_0000001765881997_p9584193672212"><strong id="rds_19_0003__b133571710111">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0003__en-us_topic_0000001765881997_row1584153652218"><td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p185841336132215">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p858463622220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p0584123617224">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.22%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0003__p1434580163733">Project ID of a tenant in a region.</p>
|
|
<p id="rds_19_0003__en-us_topic_0000001765881997_p12584193682218">To obtain it, refer to <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0003__en-us_topic_0000001765881997_row1958443622212"><td class="cellrowborder" valign="top" width="12.24%" headers="mcps1.3.3.2.2.1.2.5.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p105841536202217">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p3584133613227">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.270000000000001%" headers="mcps1.3.3.2.2.1.2.5.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p1458416366227">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.22%" headers="mcps1.3.3.2.2.1.2.5.1.4 "><p id="rds_19_0003__en-us_topic_0000001765881997_p185841636162213">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0003__en-us_topic_0000001765881997_section5483036102211"><h4 class="sectiontitle">Request</h4><ul id="rds_19_0003__en-us_topic_0000001765881997_ul8584143616228"><li id="rds_19_0003__en-us_topic_0000001765881997_li1158419369224">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0003__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_0003__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_0003__en-us_topic_0000001718281418_p105404933817"><strong id="rds_19_0003__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_0003__en-us_topic_0000001718281418_p19540696383"><strong id="rds_19_0003__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_0003__p3553193613163"><strong id="rds_19_0003__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_0003__en-us_topic_0000001718281418_p195401796382"><strong id="rds_19_0003__b1891496684">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0003__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_0003__en-us_topic_0000001718281418_p115408916387">action</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_0003__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_0003__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_0003__p633575415171">The status to be queried.</p>
|
|
<ul id="rds_19_0003__ul733516542172"><li id="rds_19_0003__li633585441718"><strong id="rds_19_0003__b14335454191714">check</strong>: Check the pre-upgrade check status.</li><li id="rds_19_0003__li11335354131718"><strong id="rds_19_0003__b9335125451716">upgrade</strong>: Check the major version upgrade status.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_19_0003__en-us_topic_0000001765881997_li15585136142212">URI example<pre class="screen" id="rds_19_0003__en-us_topic_0000001765881997_screen430154415265">https://{<em id="rds_19_0003__en-us_topic_0000001765881997_i1350174416260">Endpoint</em>}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/status?action=upgrade</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_19_0003__en-us_topic_0000001765881997_section14485036172213"><h4 class="sectiontitle">Response</h4><ul id="rds_19_0003__en-us_topic_0000001765881997_ul158513618229"><li id="rds_19_0003__en-us_topic_0000001765881997_li5585636132216">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_19_0003__en-us_topic_0000001765881997_table16488183682216" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_19_0003__en-us_topic_0000001765881997_row758583612228"><th align="left" class="cellrowborder" valign="top" width="21.21%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_19_0003__en-us_topic_0000001765881997_p358514364222"><strong id="rds_19_0003__b151812331930">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.16%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_19_0003__en-us_topic_0000001765881997_p13585133613225"><strong id="rds_19_0003__b1994973314312">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.629999999999995%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_19_0003__en-us_topic_0000001765881997_p7585236202219"><strong id="rds_19_0003__b190118341037">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_19_0003__en-us_topic_0000001765881997_row1558510363225"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p18585536192211">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p1558533622217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0003__p1586864482018">Major version upgrade status or Pre-check status of the instance.</p>
|
|
<ul id="rds_19_0003__en-us_topic_0000001765881997_ul155851336112213"><li id="rds_19_0003__en-us_topic_0000001765881997_li175856360224"><strong id="rds_19_0003__b1825141311411">running</strong>: The pre-check or major version upgrade is in progress.</li><li id="rds_19_0003__en-us_topic_0000001765881997_li18585736142215"><strong id="rds_19_0003__b149941911418">success</strong>: The pre-check or major version upgrade is successful.</li><li id="rds_19_0003__en-us_topic_0000001765881997_li1258503616222"><strong id="rds_19_0003__b147802251413">failed</strong>: The pre-check or major version upgrade fails.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0003__en-us_topic_0000001765881997_row13585736202213"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p15585636172218">target_version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p958518365225">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p16585636202211">Target version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0003__en-us_topic_0000001765881997_row1858512365223"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p1458510368222">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p135858362229">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p165862036132211">Start time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_19_0003__en-us_topic_0000001765881997_p8586936162214"><strong id="rds_19_0003__b14584934844">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_19_0003__b4585183414416">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_19_0003__b6585143416416">Z</strong> is <strong id="rds_19_0003__b1958513341943">+0100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0003__en-us_topic_0000001765881997_row155863367224"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0003__p14336194013145">check_expiration_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p958611368224">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p65861436202212">Time when a check report expires. The format is yyyy-mm-ddThh:mm:ssZ.</p>
|
|
<p id="rds_19_0003__en-us_topic_0000001765881997_p165861736152213"><strong id="rds_19_0003__b4518119859">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_19_0003__b75181491857">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_19_0003__b15518391519">Z</strong> is <strong id="rds_19_0003__b85191391159">+0100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_19_0003__en-us_topic_0000001765881997_row3586163642218"><td class="cellrowborder" valign="top" width="21.21%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_19_0003__en-us_topic_0000001765881997_p6586193632212">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_19_0003__en-us_topic_0000001765881997_p1586336142213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.629999999999995%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_19_0003__en-us_topic_0000001765881997_p9586536142210">Details about the pre-check or upgrade report.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_19_0003__en-us_topic_0000001765881997_ul958663615223"><li id="rds_19_0003__en-us_topic_0000001765881997_li75861436182216">Example normal response<pre class="screen" id="rds_19_0003__en-us_topic_0000001765881997_screen7250917153218">{
|
|
"status": "success",
|
|
"target_version": "14.4.1",
|
|
"start_time": "2023-03-06T02:33:49+0800",
|
|
"check_expiration_time": "2023-03-13T02:33:49+0800",
|
|
"detail": "2023-03-06 18:33:26 --- pg_upgrade check task begin\n2023-03-06 18:34:40 --- pg_upgrade check on master: [user_check_report]User check success "
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="rds_19_0003__en-us_topic_0000001765881997_ul1058643618221"><li id="rds_19_0003__en-us_topic_0000001765881997_li2586103610223">Abnormal response<p id="rds_19_0003__en-us_topic_0000001765881997_p1558693642215"><a name="rds_19_0003__en-us_topic_0000001765881997_li2586103610223"></a><a name="en-us_topic_0000001765881997_li2586103610223"></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_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_19_0003__en-us_topic_0032347778_ul7858132212142"><li id="rds_19_0003__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_19_0003__en-us_topic_0032347778_p1040982941020"><a name="rds_19_0003__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_19_0003__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_19_0003__en-us_topic_0032347778_p0723374409"><a name="rds_19_0003__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_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_19_0003__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>
|
|
|