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>
348 lines
32 KiB
HTML
348 lines
32 KiB
HTML
<a name="rds_07_0003"></a><a name="rds_07_0003"></a>
|
|
|
|
<h1 class="topictitle1">Restoring Data to an Existing DB Instance</h1>
|
|
<div id="body0000002506379819"><div class="section" id="rds_07_0003__en-us_topic_0000001496833745_section61759636"><h4 class="sectiontitle">Function</h4><p id="rds_07_0003__en-us_topic_0000001496833745_p33831530">This API is used to restore a database to an existing DB Instance.</p>
|
|
<ul id="rds_07_0003__ul86705111838"><li id="rds_07_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_07_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_07_0003__en-us_topic_0000001496833745_section2563029124413"><h4 class="sectiontitle">Constraints</h4><ul id="rds_07_0003__ul1449014196451"><li id="rds_07_0003__li16344113016712">When data is restored to an existing DB instance, the API has the following constraints:<ul id="rds_07_0003__ul57204324714"><li id="rds_07_0003__li361745644316">The DB engine of the original DB instance must be the same as that of the target DB instance. For example, if the original DB instance is running MySQL, the target DB instance must also run MySQL.</li><li id="rds_07_0003__li18617115618436">For RDS for MySQL, the DB engine version of the target DB instance must be at least equal to that of the original DB instance, for example, from MySQL 5.7.25 to 5.7.27.</li><li id="rds_07_0003__li1718722733620">For RDS for PostgreSQL, the DB engine version of the target DB instance must be the same as that of the original DB instance.</li><li id="rds_07_0003__li1258572811413">For RDS for SQL Server, the time zone of the target DB instance must be the same as that of the original DB instance. Otherwise, data inconsistency may occur.</li><li id="rds_07_0003__li74328526361">For version constraints of RDS for SQL Server, see <a href="#rds_07_0003__table23213613434">Table 1</a>.</li><li id="rds_07_0003__li166170564430">The total storage space of the target DB instance must be at least equal to that of the original DB instance for RDS for MySQL.</li><li id="rds_07_0003__li17840104311711">Cross-region restoration is not supported.</li><li id="rds_07_0003__li197982110316">For RDS for MySQL DB instances, when data is restored to an existing DB instance, the case sensitivity setting of the existing DB instance must be the same as that of the original DB instance. Otherwise, the restoration may fail.</li></ul>
|
|
</li><li id="rds_07_0003__li123320610431">When data is restored to an original DB instance:<p id="rds_07_0003__p348515015425"><a name="rds_07_0003__li123320610431"></a><a name="li123320610431"></a>This API is supported only for MySQL and Microsoft SQL Server DB engines.</p>
|
|
|
|
<div class="tablenoborder"><a name="rds_07_0003__table23213613434"></a><a name="table23213613434"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__table23213613434" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Restoring to specific DB engine versions</caption><thead align="left"><tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row1134094714310"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.2.2.3.1.1"><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p434016479436">Original DB Engine Version</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.2.2.3.1.2"><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p434016477435">Restore To</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row1327135154212"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p1216222683311">2017 Standard Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p46001805399">2017 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p8600120143917">2017 Enterprise Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p76394463312">2019 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p13631944173314">2019 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row7349647154313"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p193491347194319">2017 Enterprise Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p1534920476435">2017 Enterprise Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p61031456103316">2019 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row1947042518545"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p18852182232811">2019 Standard Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p17193142010309">2019 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p13194122014305">2019 Enterprise Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p5717181715353">2022 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p14717171716356">2022 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row1198532565419"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p16635173284">2019 Enterprise Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p849719345216">2019 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p114971134182112">2019 Enterprise Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p1924313620445">2022 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row8641142213341"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p6119183011303">2022 Standard Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p6218181818370">2022 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p192182181373">2022 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_row88329228348"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.1 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p8119123013302">2022 Enterprise Edition</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.2.2.3.1.2 "><p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p19869123573710">2022 Standard Edition</p>
|
|
<p id="rds_07_0003__rds_09_0009_en-us_topic_0000001191131133_p3869103512379">2022 Enterprise Edition</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_07_0003__en-us_topic_0000001496833745_section18965813"><h4 class="sectiontitle">URI</h4><ul id="rds_07_0003__en-us_topic_0000001496833745_ul13194498"><li id="rds_07_0003__en-us_topic_0000001496833745_li41603465301">URI format<p id="rds_07_0003__en-us_topic_0000001496833745_p11160246123012"><a name="rds_07_0003__en-us_topic_0000001496833745_li41603465301"></a><a name="en-us_topic_0000001496833745_li41603465301"></a>POST https://{<em id="rds_07_0003__en-us_topic_0000001496833745_i1288545311165">endpoint</em>}/v3.1/{project_id}/instances/recovery</p>
|
|
</li></ul>
|
|
<ul id="rds_07_0003__en-us_topic_0000001496833745_ul55999443"><li id="rds_07_0003__en-us_topic_0000001496833745_li21405046">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__en-us_topic_0000001496833745_table58427690" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_07_0003__en-us_topic_0000001496833745_row1482002"><th align="left" class="cellrowborder" valign="top" width="21.3%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_07_0003__en-us_topic_0000001496833745_p52933326"><strong id="rds_07_0003__b562711421051">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_07_0003__en-us_topic_0000001496833745_p59740974"><strong id="rds_07_0003__b143216441358">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.800000000000004%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_07_0003__en-us_topic_0000001496833745_p7180698"><strong id="rds_07_0003__b1977734514517">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__en-us_topic_0000001496833745_row44765691"><td class="cellrowborder" valign="top" width="21.3%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_07_0003__en-us_topic_0000001496833745_p2142393">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_07_0003__en-us_topic_0000001496833745_p39316155">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.800000000000004%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_07_0003__p1434580163733">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_07_0003__p149071611472">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_07_0003__en-us_topic_0000001496833745_section36474591"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="rds_07_0003__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_07_0003__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_07_0003__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_07_0003__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_07_0003__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_07_0003__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_07_0003__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_07_0003__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_07_0003__p35111331332">The content type.</p>
|
|
<p id="rds_07_0003__p1351133311330">The default value is <strong id="rds_07_0003__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_07_0003__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_07_0003__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_07_0003__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_07_0003__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_07_0003__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_07_0003__en-us_topic_0000001496833745_table1723519271498" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_07_0003__en-us_topic_0000001496833745_row7236162717912"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_07_0003__en-us_topic_0000001496833745_p1823614271899"><strong id="rds_07_0003__b1870629876">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_07_0003__en-us_topic_0000001496833745_p11236192711912"><strong id="rds_07_0003__b1050756300">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.01%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_07_0003__en-us_topic_0000001496833745_p1151495102615"><strong id="rds_07_0003__b10134025151115">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.510000000000005%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_07_0003__en-us_topic_0000001496833745_p7236182717915"><strong id="rds_07_0003__b1166328693">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__en-us_topic_0000001496833745_row1423615273915"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_07_0003__p4230195918114">source</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_07_0003__p6230185941112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_07_0003__p10230155931112">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.510000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_07_0003__p02307591119">Restoration information.</p>
|
|
<p id="rds_07_0003__p17312173532">For details, see <a href="#rds_07_0003__table15343138128">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__en-us_topic_0000001496833745_row172373271597"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_07_0003__p8230105941111">target</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_07_0003__p92301659121111">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_07_0003__p14598434729">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.510000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_07_0003__p123113599116">Instance to which the backup is restored.</p>
|
|
<p id="rds_07_0003__p17705736165313">For details, see <a href="#rds_07_0003__table13185192412159">Table 6</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_07_0003__table15343138128"></a><a name="table15343138128"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__table15343138128" frame="border" border="1" rules="all"><caption><b>Table 5 </b>source field data structure description</caption><thead align="left"><tr id="rds_07_0003__row53891320125"><th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.4.4.2.5.1.1"><p id="rds_07_0003__p103841361219"><strong id="rds_07_0003__b1485420557157">Parameter</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.84%" id="mcps1.3.4.4.2.5.1.2"><p id="rds_07_0003__p14391313121214"><strong id="rds_07_0003__b17384535133910">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.889999999999999%" id="mcps1.3.4.4.2.5.1.3"><p id="rds_07_0003__p44051314123"><strong id="rds_07_0003__b93854358398">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.53%" id="mcps1.3.4.4.2.5.1.4"><p id="rds_07_0003__p2414137127"><strong id="rds_07_0003__b19385153516396">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__row2421813191218"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p13264155191218">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p2265855161214">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p1626555516125">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p167601834123114">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row85749514384"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p1953065318318">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p65301153103119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p753012532312">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p72386388315">Restoration mode of the instance. Enumerated values include:</p>
|
|
<ul id="rds_07_0003__ul1286842916197"><li id="rds_07_0003__li16868102981910"><span class="parmvalue" id="rds_07_0003__parmvalue14106203115377"><b>backup</b></span>: indicates using backup files for restoration. In this mode, <span class="parmname" id="rds_07_0003__parmname151076313376"><b>type</b></span> is not mandatory and <span class="parmname" id="rds_07_0003__parmname410715311373"><b>backup_id</b></span> is mandatory.</li><li id="rds_07_0003__li43144323192"><span class="parmvalue" id="rds_07_0003__parmvalue18771173218374"><b>timestamp</b></span>: indicates the point-in-time restoration mode. In this mode, <span class="parmname" id="rds_07_0003__parmname37721032123717"><b>type</b></span> and <span class="parmname" id="rds_07_0003__parmname107730322372"><b>restore_time</b></span> are mandatory.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row1246181331215"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p5479131120">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p164741341214">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p148131319124">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p1411834113117">ID of the backup used to restore data. This parameter must be specified when the backup file is used for restoration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row149971720381"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p1876020715326">restore_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p167604743213">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p1976018715320">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p210374443118">Time point of data restoration in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row66653965810"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p091053141310">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p1297719515141">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p29155371319">Map<String, String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p879051341613">Name of the new database after the restoration. If this parameter is available, you can restore specific databases and rename new databases.</p>
|
|
<ul id="rds_07_0003__ul209301718121719"><li id="rds_07_0003__li1692925313711">This parameter is only available to RDS for SQL Server.</li><li id="rds_07_0003__li7802191954219">If this parameter is not specified, all databases are restored by default.</li><li id="rds_07_0003__li1454115106424">Before the restoration, make sure that the size of the restored data does not exceed the purchased disk capacity. Expand disk capacity, if necessary.</li></ul>
|
|
<ul id="rds_07_0003__ul193793377397"><li id="rds_07_0003__li202971944315">You can enter multiple new database names and separate them with commas (,). The new database names can contain the original database names.</li><li id="rds_07_0003__li137933713397">New database names must be different from the original database names. If they are left blank, the original database names will be used for restoration by default.</li><li id="rds_07_0003__li137983713912">Check whether new database names are case sensitive based on the character set selected during instance creation and make sure each new database name is unique.</li><li id="rds_07_0003__li12379193719396">The total number of new and existing databases on the existing or original DB instances where data is restored cannot exceed the database quota specified by <strong id="rds_07_0003__b11861224142814">rds_databases_quota</strong>.</li><li id="rds_07_0003__li1837963713915">New database names cannot contain the following fields (case-insensitive): rdsadmin, master, msdb, tempdb, model, and resource.</li><li id="rds_07_0003__li9379143717395">New database names must consist of 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). If you want to restore data to multiple new databases, separate them with commas (,).</li><li id="rds_07_0003__li163791337153910">New database names must be different from any database names on the original DB instance.</li><li id="rds_07_0003__li837920377392">New database names must be different from any database names on the existing or original DB instances where data is restored.</li></ul>
|
|
<div class="p" id="rds_07_0003__p1936173461118">Example:<pre class="codeblock" id="rds_07_0003__codeblock5192152116814">"database_name":{"<em id="rds_07_0003__i766817412312">Original database name</em>":"<em id="rds_07_0003__i19669104116316">New database name</em>"}</pre>
|
|
</div>
|
|
<p id="rds_07_0003__p151921621181">Correct example: "database_name":{"A":"A,A1,A2","B":"B1,B2","C":""}</p>
|
|
<p id="rds_07_0003__p141923216810">Wrong example: "database_name":{"A":"A","B":"B1,B2","C":"B1,C1","D":"D1,d1"},</p>
|
|
<p id="rds_07_0003__p519292119813">Error causes are as follows:</p>
|
|
<ul id="rds_07_0003__ul1641511411414"><li id="rds_07_0003__li341510145414">The new database name (A) is the same as the original database name (A).</li><li id="rds_07_0003__li1241561411416">The new database name (B1) is not unique.</li><li id="rds_07_0003__li74151514184112">When the database name is case insensitive, the database names D1 and d1 conflict.</li></ul>
|
|
<ul id="rds_07_0003__ul1319314213810"><li id="rds_07_0003__li1519318219817">Exercise caution when restoring data to an existing or original DB instance.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_07_0003__row99927641011"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.4.2.5.1.1 "><p id="rds_07_0003__p8681418666">restore_all_database</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.84%" headers="mcps1.3.4.4.2.5.1.2 "><p id="rds_07_0003__p17681518261">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.889999999999999%" headers="mcps1.3.4.4.2.5.1.3 "><p id="rds_07_0003__p868161815616">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.53%" headers="mcps1.3.4.4.2.5.1.4 "><p id="rds_07_0003__p146814180616">Whether to restore all databases to the target instance.</p>
|
|
<p id="rds_07_0003__p54162566515">This field is available only for Microsoft SQL Server. Enumerated values include:</p>
|
|
<ul id="rds_07_0003__ul19317123714510"><li id="rds_07_0003__li113174378459"><strong id="rds_07_0003__b4384271756">true</strong>: All databases will be restored to the target instance.</li><li id="rds_07_0003__li12318173734513"><strong id="rds_07_0003__b172785157612">false</strong>: Not all databases will be restored to the target instance.</li></ul>
|
|
<p id="rds_07_0003__p75271514114618">The default value is <strong id="rds_07_0003__b151455151483">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_07_0003__table13185192412159"></a><a name="table13185192412159"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__table13185192412159" frame="border" border="1" rules="all"><caption><b>Table 6 </b>target field data structure description</caption><thead align="left"><tr id="rds_07_0003__row13189624131514"><th align="left" class="cellrowborder" valign="top" width="19.68%" id="mcps1.3.4.5.2.5.1.1"><p id="rds_07_0003__p1191122441517"><strong id="rds_07_0003__b7392203573914">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.77%" id="mcps1.3.4.5.2.5.1.2"><p id="rds_07_0003__p1192132416156"><strong id="rds_07_0003__b133927350394">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.950000000000001%" id="mcps1.3.4.5.2.5.1.3"><p id="rds_07_0003__p8193152420154"><strong id="rds_07_0003__b14393123513394">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.6%" id="mcps1.3.4.5.2.5.1.4"><p id="rds_07_0003__p16195112415153"><strong id="rds_07_0003__b1139313351391">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__row17195102481518"><td class="cellrowborder" valign="top" width="19.68%" headers="mcps1.3.4.5.2.5.1.1 "><p id="rds_07_0003__p4195224181513">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.77%" headers="mcps1.3.4.5.2.5.1.2 "><p id="rds_07_0003__p5196162491515">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.950000000000001%" headers="mcps1.3.4.5.2.5.1.3 "><p id="rds_07_0003__p719812247154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.6%" headers="mcps1.3.4.5.2.5.1.4 "><p id="rds_07_0003__p71982245158">Specifies the ID of the DB instance where the backup will be restored to.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_07_0003__section6955195402520"><h4 class="sectiontitle">Example Request</h4><ul id="rds_07_0003__ul24501421959"><li id="rds_07_0003__li145920518382">Restore data to a DB instance from a backup.<pre class="screen" id="rds_07_0003__screen11923135132715">POST https://rds.eu-de.otc.t-systems.com/v3.1/0483b6b16e954cb88930a360d2c4e663/instances/recovery
|
|
|
|
{
|
|
"source": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
|
|
"type": "backup",
|
|
"backup_id": "2f4ddb93-b901-4b08-93d8-1d2e472f30fe"
|
|
},
|
|
"target": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
|
|
}
|
|
}</pre>
|
|
</li><li id="rds_07_0003__li610811115384">Restore all databases to a DB instance from an RDS for SQL Server backup.<pre class="screen" id="rds_07_0003__screen320455112918">{
|
|
"source": {
|
|
"instance_id": "61879e6085bc44d1831b0ce62d988fd9in04",
|
|
"type": "backup",
|
|
"backup_id": "b021670e69ba4538b7b2ed07257306aebr04",
|
|
"restore_all_database":true
|
|
},
|
|
"target": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04"
|
|
}
|
|
}</pre>
|
|
</li><li id="rds_07_0003__li1572411663819">Restore instance data to a specific point in time.<pre class="screen" id="rds_07_0003__screen19681185483514">{
|
|
"source": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01",
|
|
"type": "timestamp",
|
|
"restore_time": 1532001446987
|
|
},
|
|
"target": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin01"
|
|
}
|
|
}</pre>
|
|
</li><li id="rds_07_0003__li3484171916387">Restore some databases of an RDS for SQL Server instance to a specific point in time.<pre class="screen" id="rds_07_0003__screen13436135811355">{
|
|
"source": {
|
|
"instance_id": "61879e6085bc44d1831b0ce62d988fd9in04",
|
|
"type": "timestamp",
|
|
"restore_time": 1532001446987,
|
|
"database_name": {
|
|
"db1": "dbtest1",
|
|
"db3": ""
|
|
}
|
|
},
|
|
"target": {
|
|
"instance_id": "d8e6ca5a624745bcb546a227aa3ae1cfin04"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_07_0003__en-us_topic_0000001496833745_section59835867"><h4 class="sectiontitle">Response</h4><ul id="rds_07_0003__en-us_topic_0000001496833745_ul66273227"><li id="rds_07_0003__en-us_topic_0000001496833745_li59588135">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_07_0003__en-us_topic_0000001496833745_table66531170" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description</caption><thead align="left"><tr id="rds_07_0003__en-us_topic_0000001496833745_row12984378"><th align="left" class="cellrowborder" valign="top" width="19.220000000000002%" id="mcps1.3.6.2.1.1.2.4.1.1"><p id="rds_07_0003__en-us_topic_0000001496833745_p45101667"><strong id="rds_07_0003__b1105728018">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.01%" id="mcps1.3.6.2.1.1.2.4.1.2"><p id="rds_07_0003__en-us_topic_0000001496833745_p29356372"><strong id="rds_07_0003__b372327046">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="67.77%" id="mcps1.3.6.2.1.1.2.4.1.3"><p id="rds_07_0003__en-us_topic_0000001496833745_p29055926"><strong id="rds_07_0003__b83164261115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_07_0003__en-us_topic_0000001496833745_row1562610185558"><td class="cellrowborder" valign="top" width="19.220000000000002%" headers="mcps1.3.6.2.1.1.2.4.1.1 "><p id="rds_07_0003__p5826143617203">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.01%" headers="mcps1.3.6.2.1.1.2.4.1.2 "><p id="rds_07_0003__p3826236182018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="67.77%" headers="mcps1.3.6.2.1.1.2.4.1.3 "><p id="rds_07_0003__p48266368201">Indicates the job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_07_0003__li158029471019">Example normal response<pre class="screen" id="rds_07_0003__screen265364985514">{
|
|
"job_id": "ff80808157127d9301571bf8160c001d"
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="rds_07_0003__en-us_topic_0000001496833745_ul26818564"><li id="rds_07_0003__li1953636143515">Abnormal response<p id="rds_07_0003__p17243132562"><a name="rds_07_0003__li1953636143515"></a><a name="li1953636143515"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_07_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_07_0003__en-us_topic_0032347778_ul7858132212142"><li id="rds_07_0003__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_07_0003__en-us_topic_0032347778_p1040982941020"><a name="rds_07_0003__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_07_0003__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_07_0003__en-us_topic_0032347778_p0723374409"><a name="rds_07_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_07_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_07_0003__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
<p id="rds_07_0003__p8060118"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_07_0001.html">API v3.1 (Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|