vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/rds/api-ref/en-us_topic_0034973640.html
Wang , Deng Ke 5208dcae7b RDS API 20221104 version 
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>
2022-11-10 09:55:48 +00:00

234 lines
18 KiB
HTML
Raw Blame History

<a name="en-us_topic_0034973640"></a><a name="en-us_topic_0034973640"></a>
<h1 class="topictitle1">Returning Manual Backup Information as a List</h1>
<div id="body1470378083917"><div class="section" id="en-us_topic_0034973640__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034973640__p3631239417316">This API is used to return manual backup information as a list.</p>
</div>
<div class="section" id="en-us_topic_0034973640__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034973640__ul3084351717316"><li id="en-us_topic_0034973640__li915620217316">URI format<p id="en-us_topic_0034973640__p51813626145142"><a name="en-us_topic_0034973640__li915620217316"></a><a name="li915620217316"></a>PATH: /rds/v1/{project_id}/backups</p>
<p id="en-us_topic_0034973640__p43653696154835">Method: GET</p>
</li><li id="en-us_topic_0034973640__li21405046">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973640__table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973640__row1482002"><th align="left" class="cellrowborder" valign="top" width="21.68%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="en-us_topic_0034973640__p52933326"><strong id="en-us_topic_0034973640__b84235270691445">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.439999999999998%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="en-us_topic_0034973640__p59740974"><strong id="en-us_topic_0034973640__b842352706102346">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.88%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="en-us_topic_0034973640__p7180698"><strong id="en-us_topic_0034973640__b842352706163417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973640__row44765691"><td class="cellrowborder" valign="top" width="21.68%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="en-us_topic_0034973640__p2142393">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="28.439999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="en-us_topic_0034973640__p39316155">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="en-us_topic_0034973640__p61449911163220">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034973640__section3074340117316"><h4 class="sectiontitle">Request</h4><p id="en-us_topic_0034973640__p718753317316">None</p>
</div>
<div class="section" id="en-us_topic_0034973640__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034973640__ul26059286"><li id="en-us_topic_0034973640__li33206990">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973640__table30427456" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034973640__row47542385"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034973640__p25727981"><strong id="en-us_topic_0034973640__b42287163">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.980000000000004%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034973640__p3591713"><strong id="en-us_topic_0034973640__b842352706164541">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034973640__p22493366"><strong id="en-us_topic_0034973640__b1806919014">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973640__row10023380"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034973640__p6587426">backups</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034973640__p63819464">List data structure. For details, see <a href="#en-us_topic_0034973640__table64140254">Table 3</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034973640__p17946858">Indicates the backup information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034973640__table64140254"></a><a name="table64140254"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973640__table64140254" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backups field data structure description</caption><thead align="left"><tr id="en-us_topic_0034973640__row21591473"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0034973640__p4078883"><strong id="en-us_topic_0034973640__b2083471095">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.980000000000004%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0034973640__p61954093"><strong id="en-us_topic_0034973640__b710187970">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0034973640__p52225656"><strong id="en-us_topic_0034973640__b1541825475">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973640__row62813962174428"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p28454753174428">id</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p23133666174428">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p61887659174428">Indicates the backup ID.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row46332525174435"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p14339543174435">name</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p20652316174435">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p62224914174435">Indicates the backup file name.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row34844678174435"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p45166651174435">description</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p34620138174435">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p52767789174435">Indicates the backup description.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row9098921174441"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p14781427174441">locationRef</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p56444909174441">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p8634899174441">This is a reserved string and has no meanings.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row25497538174441"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p28151258174441">created</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p65659388174441">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p16810227174441">Indicates the backup creation time.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row23399164174441"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p9265887174441">updated</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p12339397174441">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p59967107174441">Indicates the completion time.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row19837717174457"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p44321732174457">size</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p33290526174457">Double</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p12178105174457">Indicates the file size in GB.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row16675647174457"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p15863101174457">status</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p9842793174457">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p42341685174932">Indicates the backup status.</p>
<p id="en-us_topic_0034973640__p41601346174959">Its value can be <strong id="en-us_topic_0034973640__b108765187814043">BUILDING</strong>, <strong id="en-us_topic_0034973640__b38384800914043">COMPLETED</strong>, <strong id="en-us_topic_0034973640__b141360966514043">FAILED</strong>, or <strong id="en-us_topic_0034973640__b61774096314043">DELETING</strong>.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row27314178174653"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p64964841174653">backuptype</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p27660731174653">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p2541561916522">The default value is <strong id="en-us_topic_0034973640__b130085847154130">1</strong>, indicating a manual backup.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row434205459508"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p4715477195018">dataStore</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p6144013995018">Dictionary data structure. For details, see <a href="#en-us_topic_0034973640__table64243102">Table 4</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p2824926095018">Indicates the database version.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row6425314717336"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p214192917346">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p3927857817346">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p7417132564016">Indicates the primary node ID of the DB instance.</p>
<div class="note" id="en-us_topic_0034973640__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0034973640__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
</div></div>
</td>
</tr>
<tr id="en-us_topic_0034973640__row494388659514"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034973640__p997015895227">parent_id</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034973640__p227643095227">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034973640__p5017311495227">This is a reserved string and has no meanings.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="en-us_topic_0034973640__table64243102"></a><a name="table64243102"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034973640__table64243102" frame="border" border="1" rules="all"><caption><b>Table 4 </b>dataStore field data structure description</caption><thead align="left"><tr id="en-us_topic_0034973640__row4043462"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0034973640__p59085005"><strong id="en-us_topic_0034973640__b1958873841">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0034973640__p35921916"><strong id="en-us_topic_0034973640__b287293176">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0034973640__p23994101"><strong id="en-us_topic_0034973640__b1620455540">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0034973640__row64473998"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0034973640__p55011311">type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0034973640__p17743659">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0034973640__p49175803141056">Indicates the DB engine. Valid value:</p>
<ul id="en-us_topic_0034973640__ul924933143511"><li id="en-us_topic_0034973640__li1195974113511">MySQL</li><li id="en-us_topic_0034973640__li2014417783511">PostgreSQL</li><li id="en-us_topic_0034973640__li192495323520">SQLServer</li></ul>
</td>
</tr>
<tr id="en-us_topic_0034973640__row40466701"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0034973640__p56577386">version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0034973640__p25105132">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0034973640__p50194896154118">Indicates the database version.</p>
<p id="en-us_topic_0034973640__p20249826">For example, 5.6.30.</p>
</td>
</tr>
<tr id="en-us_topic_0034973640__row38087787153458"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0034973640__p7245770153458">version_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0034973640__p26424346153458">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0034973640__p59997264153458">Indicates the database version ID. Its value is unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="en-us_topic_0034973640__ul1226458173158"><li id="en-us_topic_0034973640__li11038126173158">Response example<pre class="codeblock" id="en-us_topic_0034973640__codeblock40420875165948">{
"backups" : [ {
"id" : "2a4d0f86-67cd-408a-8b66-017454fb7793",
"name" : "50deafb3e45d451a9406ca146b71fe9a_rds-1_4f87d3c4-9e33-482f-b962-e23b30d1a18c_2016_08_23_01_59_23.tar.gz",
"description" : "",
"locationRef" : "",
"created" : "2016-08-23T03:59:23",
"updated" : "2016-08-23T04:01:40",
"size" : 0.0,
"status" : "COMPLETED",
"backuptype" : "1",
"dataStore" : {
"type" : "MySQL",
"version" : "5.6.30",
"version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
},
"instance_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c",
"parent_id" : null
}, {
"id" : "4af11460-06ec-48a4-b3ad-0e3bbdcd8ab1",
"name" : "50deafb3e45d451a9406ca146b71fe9a_rds-lichao-1_4f87d3c4-9e33-482f-b962-e23b30d1a18c_2016_08_23_16_20_00.tar.gz",
"description" : "",
"locationRef" : "",
"created" : "2016-08-23T18:20:00",
"updated" : "2016-08-23T18:22:12",
"size" : 3.73E-4,
"status" : "COMPLETED",
"backuptype" : "1",
"dataStore" : {
"type" : "MySQL",
"version" : "5.6.30",
"version_id" : "e8a8b8cc-63f8-4fb5-8d4a-24c502317a61"
},
"instance_id" : "4f87d3c4-9e33-482f-b962-e23b30d1a18c",
"parent_id" : null
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="en-us_topic_0034973640__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034973640__p28475059">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0018.html">Backup and Restoration</a></div>
</div>
</div>
View Git Blame Copy Permalink