forked from docs/doc-exports
Ru, Li Yi
9457035d64
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
147 lines
12 KiB
HTML
147 lines
12 KiB
HTML
<a name="rds_09_0006"></a><a name="rds_09_0006"></a>
|
|
|
|
<h1 class="topictitle1">Obtaining the Link for Downloading a Backup File</h1>
|
|
<div id="body1537345764988"><div class="section" id="rds_09_0006__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_09_0006__p3631239417316">This API is used to obtain the link for downloading a backup file.</p>
|
|
<ul id="rds_09_0006__ul12259155218373"><li id="rds_09_0006__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_0006__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_0006__section1956333494215"><h4 class="sectiontitle">Constraints</h4><p id="rds_09_0006__p1678154611263">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_0006__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0006__ul3084351717316"><li id="rds_09_0006__li41551646201910">URI format<p id="rds_09_0006__p111551846201916"><a name="rds_09_0006__li41551646201910"></a><a name="li41551646201910"></a>GET https://{<em id="rds_09_0006__i117181932151618">Endpoint</em>}/v3/{project_id}/backup-files?backup_id={backup_id}</p>
|
|
</li><li id="rds_09_0006__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0006__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0006__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_0006__p34889605"><strong id="rds_09_0006__b13302713212">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.849999999999998%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="rds_09_0006__p7485743"><strong id="rds_09_0006__b10312717213">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.46%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="rds_09_0006__p2365466"><strong id="rds_09_0006__b11317271213">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0006__row57385070"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0006__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.849999999999998%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0006__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.46%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0006__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_09_0006__p35815231088">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_0006__row116836431146"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="rds_09_0006__p15683443151415">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.849999999999998%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="rds_09_0006__p1568316439148">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.46%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="rds_09_0006__p116832437149">Specifies the backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0006__section28070818101549"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0006__ul1183180183717"><li id="rds_09_0006__li1283110163719">Request parameters<p id="rds_09_0006__p848415163614"><a name="rds_09_0006__li1283110163719"></a><a name="li1283110163719"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_09_0006__ul299599175212"><li id="rds_09_0006__li4411135064210">Example<p id="rds_09_0006__p1454414211213"><a name="rds_09_0006__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backup-files?backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_09_0006__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0006__ul12573920"><li id="rds_09_0006__li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0006__table11854613" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0006__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_0006__p54712068"><strong id="rds_09_0006__b106172762115">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_0006__p2492560"><strong id="rds_09_0006__b8620273213">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_0006__p570775"><strong id="rds_09_0006__b12662712219">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0006__row46232835"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0006__p53872188">files</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0006__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_0006__p4491214">Indicates the list of backup files.</p>
|
|
<p id="rds_09_0006__p14951152394619">For details, see <a href="#rds_09_0006__table52869820">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0006__row1115175204712"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_09_0006__p611517554719">bucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_09_0006__p2756199134714">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_09_0006__p1011512524711">Indicates the name of the bucket where the file is located.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_09_0006__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0006__table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>files field data structure description</caption><thead align="left"><tr id="rds_09_0006__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_0006__p31833731"><strong id="rds_09_0006__b58122711211">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_0006__p28395444"><strong id="rds_09_0006__b108192732110">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_0006__p18329666"><strong id="rds_09_0006__b391527152116">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_09_0006__row938736142915"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0006__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_0006__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_0006__p72791658307">Indicates the file name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0006__row144491595298"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0006__p4279155173020">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_0006__p11279125203010">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_0006__p16279165203010">Indicates the file size in KB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0006__row14746325132919"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0006__p42659508172">download_link</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="rds_09_0006__p726525091715">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_0006__p112651850111716">Indicates the link for downloading the backup file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0006__row168721916122920"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0006__p29686511175">link_expired_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_0006__p79681651201718">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_0006__p727911543019">Indicates the link expiration time. The format is "yyyy-mm-ddThh:mm:ssZ". <strong id="rds_09_0006__b1111027102111">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_09_0006__b15111027182110">Z</strong> indicates the time zone offset. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_09_0006__row559124084710"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="rds_09_0006__p1883139114916">database_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_0006__p88317395491">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_0006__p178353984913">Indicates the name of the database. If the backup file is not a database backup file, null is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_09_0006__ul16665627"><li id="rds_09_0006__li15772917">Example normal response<pre class="codeblock" id="rds_09_0006__codeblock314170531760">{
|
|
"files": [
|
|
{
|
|
"name": "43e4feaab48f11e89039fa163ebaa7e4br01.xxx",
|
|
"size": 2803,
|
|
"download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx",
|
|
"link_expired_time":"2018-08-016T10:15:14+0800"
|
|
}
|
|
],
|
|
"bucket": "rdsbucket.bucketname"
|
|
}
|
|
</pre>
|
|
</li><li id="rds_09_0006__li11443112327">Abnormal response<p id="rds_09_0006__p109861827464"><a name="rds_09_0006__li11443112327"></a><a name="li11443112327"></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_0006__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0006__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0006__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0006__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0006__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_09_0006__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0006__en-us_topic_0032347778_p0723374409"><a name="rds_09_0006__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_0006__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0006__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>
|
|
|