yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/geminidb/api-ref/BatchUpgradeDbVersion.html
wangdengke2 59805c5073 GeminiDB_API 
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>
2026-03-12 09:56:41 +00:00

238 lines
18 KiB
HTML
Raw Blame History

<a name="BatchUpgradeDbVersion"></a><a name="BatchUpgradeDbVersion"></a>
<h1 class="topictitle1">Patching Databases In Batches</h1>
<div id="body0000002082679073"><div class="section" id="BatchUpgradeDbVersion__section79454306444"><h4 class="sectiontitle">Function</h4><p id="BatchUpgradeDbVersion__p10945193074415">This API is used to patch databases in batches.</p>
</div>
<div class="section" id="BatchUpgradeDbVersion__section3945193074414"><h4 class="sectiontitle">Constraints</h4><ul id="BatchUpgradeDbVersion__ul34891759155916"><li id="BatchUpgradeDbVersion__li1189410102">This API supports the following types of instances:<ul id="BatchUpgradeDbVersion__ul79512198317"><li id="BatchUpgradeDbVersion__li695113197315">GeminiDB Cassandra</li><li id="BatchUpgradeDbVersion__li8951181913120"><span id="BatchUpgradeDbVersion__text11705124413519">GeminiDB Influx</span></li></ul>
</li></ul>
<ul id="BatchUpgradeDbVersion__ul9946143094417"><li id="BatchUpgradeDbVersion__li15355199101414">Upgrade is triggered immediately, so patch databases during off-peak hours.</li></ul>
</div>
<div class="section" id="BatchUpgradeDbVersion__section694920307442"><h4 class="sectiontitle">URI</h4><p id="BatchUpgradeDbVersion__p10949203054419">POST https://{Endpoint}/v3/{project_id}/instances/db-upgrade</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__table9951930144416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row995016305447"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="BatchUpgradeDbVersion__p15951133034415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="BatchUpgradeDbVersion__p695263014410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="BatchUpgradeDbVersion__p16952123094412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="BatchUpgradeDbVersion__p19953133014411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row99501330134417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="BatchUpgradeDbVersion__p18953430124414">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="BatchUpgradeDbVersion__p795311305448">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="BatchUpgradeDbVersion__p8954530104413">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="BatchUpgradeDbVersion__p199552030144415">Project ID of a tenant in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchUpgradeDbVersion__section19581303443"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__nosql_06_0005_row297143315291"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="BatchUpgradeDbVersion__nosql_06_0005_p17971633152910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="BatchUpgradeDbVersion__nosql_06_0005_p15971173312295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="BatchUpgradeDbVersion__nosql_06_0005_p1497113315294">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="BatchUpgradeDbVersion__nosql_06_0005_p19711233132916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__nosql_06_0005_row12796421299"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p182260435293">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p422616439293">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p102267431294">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p822614372917">MIME type of the request body. <strong id="BatchUpgradeDbVersion__nosql_06_0005_b17987151714249">application/json</strong> is recommended.</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__nosql_06_0005_row59728331292"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p179727333296">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p797273392915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p18972133192915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="BatchUpgradeDbVersion__nosql_06_0005_p1797243342916">User token</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__table16835181610335" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row1936716123310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="BatchUpgradeDbVersion__p11936131643318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.4.3.2.5.1.2"><p id="BatchUpgradeDbVersion__p20936121603320">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.02%" id="mcps1.3.4.3.2.5.1.3"><p id="BatchUpgradeDbVersion__p293616162337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="BatchUpgradeDbVersion__p1193617162331">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row59362162338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="BatchUpgradeDbVersion__p798451716198">instance_ids</p>
</td>
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.3.2.5.1.2 "><p id="BatchUpgradeDbVersion__p17984817171915">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.4.3.2.5.1.3 "><p id="BatchUpgradeDbVersion__p9984141711912">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="BatchUpgradeDbVersion__p7984101731916">IDs of instances where databases need to be patched. Up to 10 IDs of an instance of the same GeminiDB engine type can be specified at a time.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchUpgradeDbVersion__section29629304440"><h4 class="sectiontitle">Response Parameters</h4><p id="BatchUpgradeDbVersion__p1396333014445">Status code: 202</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__response_UpgradeDbVersionResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row496383054418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="BatchUpgradeDbVersion__p15964530124417">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="BatchUpgradeDbVersion__p696543034419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="BatchUpgradeDbVersion__p109651730124413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row1596423034413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="BatchUpgradeDbVersion__p1731064414018">upgrade_results</p>
</td>
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="BatchUpgradeDbVersion__p10310544154013"><a href="#BatchUpgradeDbVersion__table1235216577419">Array of objects</a></p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="BatchUpgradeDbVersion__p2310244184012">Batch upgrade result</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="BatchUpgradeDbVersion__table1235216577419"></a><a name="table1235216577419"></a><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__table1235216577419" frame="border" border="1" rules="all"><caption><b>Table 5 </b>UpgradeResult</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row193531575419"><th align="left" class="cellrowborder" valign="top" width="19.94199419941994%" id="mcps1.3.5.4.2.4.1.1"><p id="BatchUpgradeDbVersion__p1179587104216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.173017301730177%" id="mcps1.3.5.4.2.4.1.2"><p id="BatchUpgradeDbVersion__p14795187204212">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.884988498849886%" id="mcps1.3.5.4.2.4.1.3"><p id="BatchUpgradeDbVersion__p8795147104218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row1535319571418"><td class="cellrowborder" valign="top" width="19.94199419941994%" headers="mcps1.3.5.4.2.4.1.1 "><p id="BatchUpgradeDbVersion__p146561617154215">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.173017301730177%" headers="mcps1.3.5.4.2.4.1.2 "><p id="BatchUpgradeDbVersion__p1665651744216">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.884988498849886%" headers="mcps1.3.5.4.2.4.1.3 "><p id="BatchUpgradeDbVersion__p4656917104213">Task ID returned only when a patch installation task is successfully submitted</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__row133537577416"><td class="cellrowborder" valign="top" width="19.94199419941994%" headers="mcps1.3.5.4.2.4.1.1 "><p id="BatchUpgradeDbVersion__p116566170423">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="30.173017301730177%" headers="mcps1.3.5.4.2.4.1.2 "><p id="BatchUpgradeDbVersion__p1165661714211">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.884988498849886%" headers="mcps1.3.5.4.2.4.1.3 "><p id="BatchUpgradeDbVersion__p565691774219">Instance ID</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__row103536576411"><td class="cellrowborder" valign="top" width="19.94199419941994%" headers="mcps1.3.5.4.2.4.1.1 "><p id="BatchUpgradeDbVersion__p1656171717424">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="30.173017301730177%" headers="mcps1.3.5.4.2.4.1.2 "><p id="BatchUpgradeDbVersion__p86566172423">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.884988498849886%" headers="mcps1.3.5.4.2.4.1.3 "><p id="BatchUpgradeDbVersion__p1465691764215">Error code returned only when a patch installation task fails to be submitted</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__row15353125717419"><td class="cellrowborder" valign="top" width="19.94199419941994%" headers="mcps1.3.5.4.2.4.1.1 "><p id="BatchUpgradeDbVersion__p1865651784216">error_message</p>
</td>
<td class="cellrowborder" valign="top" width="30.173017301730177%" headers="mcps1.3.5.4.2.4.1.2 "><p id="BatchUpgradeDbVersion__p1765691794213">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.884988498849886%" headers="mcps1.3.5.4.2.4.1.3 "><p id="BatchUpgradeDbVersion__p196561617194215">Failure cause returned only when a patch installation task fails to be submitted</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="BatchUpgradeDbVersion__p1154034794610">Status code: 400</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__table14473191216475" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row204731212114715"><th align="left" class="cellrowborder" valign="top" width="19.43194319431943%" id="mcps1.3.5.6.2.4.1.1"><p id="BatchUpgradeDbVersion__p4112238114718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.113111311131114%" id="mcps1.3.5.6.2.4.1.2"><p id="BatchUpgradeDbVersion__p511213844717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.45494549454945%" id="mcps1.3.5.6.2.4.1.3"><p id="BatchUpgradeDbVersion__p16112238134713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row17473111211474"><td class="cellrowborder" valign="top" width="19.43194319431943%" headers="mcps1.3.5.6.2.4.1.1 "><p id="BatchUpgradeDbVersion__p2011263804717">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="31.113111311131114%" headers="mcps1.3.5.6.2.4.1.2 "><p id="BatchUpgradeDbVersion__p1311214384472">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.45494549454945%" headers="mcps1.3.5.6.2.4.1.3 "><p id="BatchUpgradeDbVersion__p181121938104712">Error code</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__row447315127474"><td class="cellrowborder" valign="top" width="19.43194319431943%" headers="mcps1.3.5.6.2.4.1.1 "><p id="BatchUpgradeDbVersion__p31123389474">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="31.113111311131114%" headers="mcps1.3.5.6.2.4.1.2 "><p id="BatchUpgradeDbVersion__p1311293817479">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.45494549454945%" headers="mcps1.3.5.6.2.4.1.3 "><p id="BatchUpgradeDbVersion__p31121638154720">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="BatchUpgradeDbVersion__p87602535474">Status code: 500</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="BatchUpgradeDbVersion__table838614151489" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="BatchUpgradeDbVersion__row14386715104814"><th align="left" class="cellrowborder" valign="top" width="19.171917191719174%" id="mcps1.3.5.8.2.4.1.1"><p id="BatchUpgradeDbVersion__p1065394214480">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31.543154315431543%" id="mcps1.3.5.8.2.4.1.2"><p id="BatchUpgradeDbVersion__p26531742134814">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.28492849284928%" id="mcps1.3.5.8.2.4.1.3"><p id="BatchUpgradeDbVersion__p1965319422487">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="BatchUpgradeDbVersion__row203861015114811"><td class="cellrowborder" valign="top" width="19.171917191719174%" headers="mcps1.3.5.8.2.4.1.1 "><p id="BatchUpgradeDbVersion__p1565311429489">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="31.543154315431543%" headers="mcps1.3.5.8.2.4.1.2 "><p id="BatchUpgradeDbVersion__p136531642174813">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.28492849284928%" headers="mcps1.3.5.8.2.4.1.3 "><p id="BatchUpgradeDbVersion__p7653104264817">Error code</p>
</td>
</tr>
<tr id="BatchUpgradeDbVersion__row8386715144817"><td class="cellrowborder" valign="top" width="19.171917191719174%" headers="mcps1.3.5.8.2.4.1.1 "><p id="BatchUpgradeDbVersion__p3653442204819">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="31.543154315431543%" headers="mcps1.3.5.8.2.4.1.2 "><p id="BatchUpgradeDbVersion__p56531842124815">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.28492849284928%" headers="mcps1.3.5.8.2.4.1.3 "><p id="BatchUpgradeDbVersion__p465316420485">Error message</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="BatchUpgradeDbVersion__section1096743094414"><h4 class="sectiontitle">Example Requests</h4><div class="p" id="BatchUpgradeDbVersion__p135979379256">URI example<pre class="screen" id="BatchUpgradeDbVersion__screen1648751017456">POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade</pre>
</div>
<p id="BatchUpgradeDbVersion__p512903115522">Example Requests</p>
<div class="p" id="BatchUpgradeDbVersion__p941425155315">Patching databases in batches<pre class="screen" id="BatchUpgradeDbVersion__screen107770071819">{
"instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ]
}</pre>
</div>
</div>
<div class="section" id="BatchUpgradeDbVersion__section696953013447"><h4 class="sectiontitle">Example Responses</h4><p id="BatchUpgradeDbVersion__p2969113084419">Status code: 202</p>
<p id="BatchUpgradeDbVersion__p3970163054417">Accepted</p>
<pre class="screen" id="BatchUpgradeDbVersion__screen156854810534">{
"upgrade_results" : [ {
"instance_id" : "046287aae57843b1a7bc61b7a8812f41in13",
"job_id" : "e4616470-733d-41de-a9b0-a260709293d3"
}, {
"instance_id" : "3d1e04f49efa473a8c7eaf07ed7ff870in13",
"error_code" : "DBS.200011",
"error_message" : "The status of DB instance does not allow the operation."
} ]
}</pre>
</div>
<div class="section" id="BatchUpgradeDbVersion__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="BatchUpgradeDbVersion__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
</div>
<div class="section" id="BatchUpgradeDbVersion__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="BatchUpgradeDbVersion__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000002.html">Instances</a></div>
</div>
</div>
View Git Blame Copy Permalink