forked from docs/doc-exports
Wang , Deng Ke
21e968a153
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
333 lines
27 KiB
HTML
333 lines
27 KiB
HTML
<a name="rds_09_0005"></a><a name="rds_09_0005"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining Details About Backups</h1>
|
|
<div id="body1537345764988"><div class="section" id="rds_09_0005__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_09_0005__p3631239417316">This API is used to obtain details about backups.</p>
|
|
<ul id="rds_09_0005__ul12259155218373"><li id="rds_09_0005__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_09_0005__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_09_0005__section201140547419"><h4 class="sectiontitle">Constraints</h4><p id="rds_09_0005__p19727688151526">This API is used to query full backups of MySQL, PostgreSQL, and Microsoft SQL Server databases and incremental backups of MySQL and PostgreSQL databases.</p>
|
|
</div>
|
|
<div class="section" id="rds_09_0005__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0005__ul3084351717316"><li id="rds_09_0005__li915620217316">URI format<p id="rds_09_0005__p2567371617050"><a name="rds_09_0005__li915620217316"></a><a name="li915620217316"></a>GET https://{<em id="rds_09_0005__i5606182911612">Endpoint</em>}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time}</p>
|
|
</li><li id="rds_09_0005__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0005__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0005__row60083059"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="rds_09_0005__p34889605"><strong id="rds_09_0005__b15943172632117">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.38%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_09_0005__p7485743"><strong id="rds_09_0005__b294342652110">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.93%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_09_0005__p2365466"><strong id="rds_09_0005__b69434265216">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0005__row57385070"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0005__p1511718177816">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row2864326155157"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row116836431146"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p15683443151415">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p1568316439148">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p116832437149">Specifies the backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row93931049203017"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p840844912305">backup_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p134086490304">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p5408194916301">Specifies the backup type. Value:</p>
|
|
<ul id="rds_09_0005__ul189282231193"><li id="rds_09_0005__li88283251911"><strong id="rds_09_0005__b9681345131518">auto</strong>: automated full backup</li><li id="rds_09_0005__li344972812913"><strong id="rds_09_0005__b96513542159">manual</strong>: manual full backup</li><li id="rds_09_0005__li101131530596"><strong id="rds_09_0005__b143921216161">fragment</strong>: differential full backup</li><li id="rds_09_0005__li892810231891"><strong id="rds_09_0005__b96431097168">incremental</strong>: automated incremental backup</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row115851253324"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p7585625113212">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p14241079113">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p19585152511326">Specifies the index position. If <strong id="rds_09_0005__b189471126182118">offset</strong> is set to <em id="rds_09_0005__i12947162662111">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="rds_09_0005__b59472026142116">0</strong> by default, indicating that the query starts from the first piece of data. The value must be a positive number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row16990146131215"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p139904468126">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p4990946181217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p189901246201211">Specifies the number of records to be queried. The default value is <strong id="rds_09_0005__b16325644124312">100</strong>. The value cannot be a negative number. The minimum value is <strong id="rds_09_0005__b15325194411434">1</strong> and the maximum value is <strong id="rds_09_0005__b732694416437">100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row820715219196"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p1250401361914">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p5426101961917">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p1942671971913">Specifies the start time for obtaining the backup list. The format of the start time is "yyyy-mm-ddThh:mm:ssZ".</p>
|
|
<p id="rds_09_0005__p442615191195"><strong id="rds_09_0005__b457716103450">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0005__b257731054515">Z</strong> indicates the time zone offset. </p>
|
|
<div class="note" id="rds_09_0005__note1546714962017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_09_0005__p9467189102011">When <span class="parmname" id="rds_09_0005__parmname1170415591469"><b>begin_time</b></span> is not empty, <span class="parmname" id="rds_09_0005__parmname91712464711"><b>end_time</b></span> is mandatory.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row659875021813"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0005__p1050431341917">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.38%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0005__p14262196190">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.93%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0005__p1542651981915">Specifies the end time for obtaining the backup list. The format of the end time is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.</p>
|
|
<p id="rds_09_0005__p10426101991919"><strong id="rds_09_0005__b395015261210">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0005__b109501026162110">Z</strong> indicates the time zone offset. </p>
|
|
<div class="note" id="rds_09_0005__note10667645111414"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_09_0005__p14667845141419">When <span class="parmname" id="rds_09_0005__parmname1485717617479"><b>end_time</b></span> is not empty, <span class="parmname" id="rds_09_0005__parmname1530818954711"><b>begin_time</b></span> is mandatory.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0005__section28070818101549"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0005__ul1183180183717"><li id="rds_09_0005__li1283110163719">Request parameters<p id="rds_09_0005__p848415163614"><a name="rds_09_0005__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0005__ul6215131255112"><li id="rds_09_0005__li4411135064210">Example<p id="rds_09_0005__p1454414211213"><a name="rds_09_0005__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0005__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0005__ul12573920"><li id="rds_09_0005__li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0005__table11854613" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0005__row48728718"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_09_0005__p54712068"><strong id="rds_09_0005__b695252672114">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_09_0005__p2492560"><strong id="rds_09_0005__b39521326162111">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_09_0005__p570775"><strong id="rds_09_0005__b1195232682112">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0005__row46232835"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0005__p53872188">backups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0005__p24228398437">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0005__p4491214">Indicates the backup list.</p>
|
|
<p id="rds_09_0005__p19557583458">For details, see <a href="#rds_09_0005__table52869820">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row1115175204712"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0005__p611517554719">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0005__p2756199134714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0005__p1011512524711">Indicates the total number of records.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0005__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0005__table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backups field data structure description</caption><thead align="left"><tr id="rds_09_0005__row50931783"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="rds_09_0005__p31833731"><strong id="rds_09_0005__b4956162622115">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="rds_09_0005__p28395444"><strong id="rds_09_0005__b1595616264212">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="rds_09_0005__p18329666"><strong id="rds_09_0005__b9956226162115">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0005__row8307988"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p127914503011">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p027913523010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p172799513012">Indicates the backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row938736142915"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p92797519305">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p52796523018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p72791658307">Indicates the backup name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row144491595298"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p4279155173020">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p11279125203010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p72791553309">Indicates the backup type. Value:</p>
|
|
<ul id="rds_09_0005__ul139214209182"><li id="rds_09_0005__en-us_topic_0224329963_li88283251911"><strong id="rds_09_0005__en-us_topic_0224329963_b9681345131518">auto</strong>: automated full backup</li><li id="rds_09_0005__en-us_topic_0224329963_li344972812913"><strong id="rds_09_0005__en-us_topic_0224329963_b96513542159">manual</strong>: manual full backup</li><li id="rds_09_0005__en-us_topic_0224329963_li101131530596"><strong id="rds_09_0005__en-us_topic_0224329963_b143921216161">fragment</strong>: differential full backup</li><li id="rds_09_0005__en-us_topic_0224329963_li892810231891"><strong id="rds_09_0005__en-us_topic_0224329963_b96431097168">incremental</strong>: automated incremental backup</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row1351211233292"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p2027911543018">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p72791059304">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p1327935123018">Indicates the backup size in kB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row14746325132919"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p192791152308">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p22798533017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p10279105193013">Indicates the backup status. Value:</p>
|
|
<ul id="rds_09_0005__ul132531445184"><li id="rds_09_0005__li4678464183">BUILDING: Backup in progress</li><li id="rds_09_0005__li147769818183">COMPLETED: Backup completed</li><li id="rds_09_0005__li14847510131819">FAILED: Backup failed</li><li id="rds_09_0005__li1725318417187">DELETING: Backup being deleted</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row168721916122920"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p527917513306">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p1527919573018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p727911543019">Indicates the backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
|
<p id="rds_09_0005__p92795593018"><strong id="rds_09_0005__b1096152616215">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0005__b13961726172114">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row1938722120299"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p1227912514309">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p627916517309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p9750141761712">Indicates the backup end time.</p>
|
|
<ul id="rds_09_0005__ul99235321713"><li id="rds_09_0005__li14668115501717">In a full backup, it indicates the full backup end time.</li><li id="rds_09_0005__li292165311172">In a MySQL incremental backup, it indicates the time when the last transaction in the backup file is submitted.</li></ul>
|
|
<p id="rds_09_0005__p2027975153016">The format is yyyy-mm-ddThh:mm:ssZ. <strong id="rds_09_0005__b842352706151812">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0005__b842352706153833">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row16168101920298"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p327925163018">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p1427918593019">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p15279195123012">Indicates the database version.</p>
|
|
<p id="rds_09_0005__p279492744510">For details, see <a href="#rds_09_0005__table32267243">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row1912113128299"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p32795583015">databases</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p527912519305">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p1627917517304">Indicates a list of self-built Microsoft SQL Server databases that support partial backups.</p>
|
|
<p id="rds_09_0005__p48331337114511">For details, see <a href="#rds_09_0005__table4541911203517">Table 5</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row11777181462914"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0005__p62796513300">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0005__p10279255302">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="rds_09_0005__p827914583018">Indicates the ID of the DB instance for which the backup is created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0005__table32267243"></a><a name="table32267243"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0005__table32267243" frame="border" border="1" rules="all"><caption><b>Table 4 </b>datastore field data structure description</caption><thead align="left"><tr id="rds_09_0005__row9230088"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="rds_09_0005__p9439626"><strong id="rds_09_0005__b596419262217">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="rds_09_0005__p26412257"><strong id="rds_09_0005__b1896517269213">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="rds_09_0005__p59018101"><strong id="rds_09_0005__b8965226162114">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0005__row15736877"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_09_0005__p66727538">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_09_0005__p36221483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_09_0005__p1051011533343">Indicates the DB engine. Its value can be any of the following and is case-insensitive:</p>
|
|
<ul id="rds_09_0005__ul924933143511"><li id="rds_09_0005__li1195974113511">MySQL</li><li id="rds_09_0005__li2014417783511">PostgreSQL</li><li id="rds_09_0005__li192495323520">SQLServer</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0005__row130794519346"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="rds_09_0005__p104325063513">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="rds_09_0005__p194327013514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="rds_09_0005__p043213063517">Indicates the database version.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0005__table4541911203517"></a><a name="table4541911203517"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0005__table4541911203517" frame="border" border="1" rules="all"><caption><b>Table 5 </b>databases field data structure description</caption><thead align="left"><tr id="rds_09_0005__row1855714116356"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="rds_09_0005__p255718115359"><strong id="rds_09_0005__b496710262218">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="rds_09_0005__p4557181118353"><strong id="rds_09_0005__b2967926162119">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="rds_09_0005__p1255717116353"><strong id="rds_09_0005__b49671026102116">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0005__row125579116351"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="rds_09_0005__p1155714112354">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="rds_09_0005__p4557101117355">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="rds_09_0005__p3573151117359">Indicates the name of the self-built database.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0005__ul16665627"><li id="rds_09_0005__li15772917">Example normal response<p id="rds_09_0005__p1426918267176"><a name="rds_09_0005__li15772917"></a><a name="li15772917"></a>Obtaining a backup list of a MySQL DB instance:</p>
|
|
<pre class="codeblock" id="rds_09_0005__codeblock668813194198">{
|
|
"backups": [{
|
|
"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
|
|
"name": "xxxx.xxx",
|
|
"type": "auto",
|
|
"size": 2803,
|
|
"status": "COMPLETED",
|
|
"begin_time": "2018-08-06T12:41:14+0800",
|
|
"end_time": "2018-08-06T12:43:14+0800",
|
|
"datastore": {
|
|
"type": "MySQL",
|
|
"version": "8.0"
|
|
},
|
|
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01"
|
|
}],
|
|
"total_count": 1
|
|
}</pre>
|
|
<p id="rds_09_0005__p10429186161815"></p>
|
|
<p id="rds_09_0005__p128874601819">Obtaining a backup list of a PostgreSQL DB instance:</p>
|
|
<pre class="codeblock" id="rds_09_0005__codeblock36011943121916">{
|
|
"backups": [{
|
|
"id": "43e4feaab48f11e89039fa163ebaa7e4br03",
|
|
"name": "xxxx.xxx",
|
|
"type": "incremental",
|
|
"size": 2803,
|
|
"status": "COMPLETED",
|
|
"begin_time": "2018 - 08 - 06 T12: 41: 14 + 0800",
|
|
"end_time": "2018 - 08 - 06 T12: 43: 14 + 0800",
|
|
"datastore": {
|
|
"type": "PostgreSQL",
|
|
"version": "13"
|
|
},
|
|
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 "
|
|
}],
|
|
"total_count": 1
|
|
}</pre>
|
|
<p id="rds_09_0005__p17341125115189"></p>
|
|
<p id="rds_09_0005__p841218223187">Obtaining a backup list of a Microsoft SQL Server DB instance:</p>
|
|
<pre class="codeblock" id="rds_09_0005__codeblock218310272019">{
|
|
"backups": [{
|
|
"id ": "43e4feaab48f11e89039fa163ebaa7e4br04",
|
|
"name": "xxxx.xxx",
|
|
"type": "manual",
|
|
"size": 2803,
|
|
"status": "COMPLETED",
|
|
"begin_time": "2018-08-06T12:41:14+0800",
|
|
"end_time": "2018-08-06T12:43:14+0800",
|
|
"datastore": {
|
|
"type": "SQLServer",
|
|
"version": "2017_SE"
|
|
},
|
|
"databases": [{
|
|
"name": "user01"
|
|
}, {
|
|
"name": "user02"
|
|
}],
|
|
"instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04"
|
|
}],
|
|
"total_count": 1
|
|
}</pre>
|
|
</li><li id="rds_09_0005__li3192582299">Abnormal Response<p id="rds_09_0005__p28475059"><a name="rds_09_0005__li3192582299"></a><a name="li3192582299"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0005__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0005__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0005__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0005__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0005__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0005__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0005__en-us_topic_0032347778_p0723374409"><a name="rds_09_0005__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_09_0005__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0005__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="en-us_topic_0032347777.html">Backup and Restoration</a></div>
|
|
</div>
|
|
</div>
|
|
|