youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0059.html
Wang , Deng Ke 60010eb9d0 dds api 2.0.38sp24 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>
2023-01-13 08:55:41 +00:00

141 lines
10 KiB
HTML
Raw Permalink Blame History

<a name="dds_api_0059"></a><a name="dds_api_0059"></a>
<h1 class="topictitle1">Obtaining the Link for Downloading a Backup File</h1>
<div id="body1597990847474"><div class="section" id="dds_api_0059__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0059__p3631239417316">This API is used to obtain the link for downloading a backup file.</p>
</div>
<div class="section" id="dds_api_0059__section1956333494215"><h4 class="sectiontitle">Constraints</h4><p id="dds_api_0059__p4917735171210">The backup download link is valid within 15 minutes after being updated.</p>
</div>
<div class="section" id="dds_api_0059__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0059__ul3084351717316"><li id="dds_api_0059__li41551646201910">URI format<p id="dds_api_0059__p111551846201916"><a name="dds_api_0059__li41551646201910"></a><a name="li41551646201910"></a>GET https://{Endpoint}/v3/{project_id}/backups/download-file?instance_id={instance_id}&amp;backup_id={backup_id}</p>
</li><li id="dds_api_0059__li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0059__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0059__row60083059"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0059__p34889605">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.16%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0059__p7485743">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.150000000000006%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0059__p2365466">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0059__row57385070"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0059__p17679057">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0059__p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0059__p28182251">Specifies the project ID of a tenant in a region.</p>
<p id="dds_api_0059__p35815231088">For details about how to obtain the project ID, see <a href="dds_projectid.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="dds_api_0059__row1632194402218"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0059__p10321844122216">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0059__p93264422218">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0059__p332104412229">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
</td>
</tr>
<tr id="dds_api_0059__row116836431146"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0059__p15683443151415">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.16%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0059__p1568316439148">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0059__p116832437149">Specifies the backup ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0059__section28070818101549"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0059__ul215821111117"><li id="dds_api_0059__li11159131141111">Example request<p id="dds_api_0059__p72879147116"><a name="dds_api_0059__li11159131141111"></a><a name="li11159131141111"></a>GET https://dds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups/download-file?instance_id=befb1cfe1f96403780396b0c54f85d11in02&amp;backup_id=bd062e1af2d248b3bb4cd3dbb4183888br02</p>
</li></ul>
</div>
<div class="section" id="dds_api_0059__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0059__ul12573920"><li id="dds_api_0059__li46056421">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0059__table11854613" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0059__row48728718"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0059__p54712068">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0059__p2492560">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0059__p570775">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0059__row46232835"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0059__p53872188">files</p>
</td>
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0059__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="dds_api_0059__p4491214">Indicates the list of backup files.</p>
<p id="dds_api_0059__p14951152394619">For more information, see <a href="#dds_api_0059__table52869820">Table 3</a>.</p>
</td>
</tr>
<tr id="dds_api_0059__row1115175204712"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0059__p611517554719">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0059__p2756199134714">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0059__p1011512524711">Indicates the name of the bucket where the file is located.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0059__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0059__table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>files field data structure description</caption><thead align="left"><tr id="dds_api_0059__row50931783"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="dds_api_0059__p31833731">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="31%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="dds_api_0059__p28395444">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="dds_api_0059__p18329666">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0059__row938736142915"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0059__p92797519305">name</p>
</td>
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0059__p52796523018">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0059__p72791658307">Indicates the file name.</p>
</td>
</tr>
<tr id="dds_api_0059__row144491595298"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0059__p4279155173020">size</p>
</td>
<td class="cellrowborder" valign="top" width="31%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0059__p11279125203010">Long</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0059__p16279165203010">Indicates the file size in KB.</p>
</td>
</tr>
<tr id="dds_api_0059__row14746325132919"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0059__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="dds_api_0059__p726525091715">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0059__p112651850111716">Indicates the link for downloading the backup file.</p>
</td>
</tr>
<tr id="dds_api_0059__row168721916122920"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0059__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="dds_api_0059__p79681651201718">String</p>
</td>
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0059__p727911543019">Indicates the link expiration time. The format is "yyyy-mm-ddThh:mm:ssZ". <strong id="dds_api_0059__b934614111412">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="dds_api_0059__b1034710419142">Z</strong> indicates the time zone offset. For example, the time zone offset of UTC is shown as <strong id="dds_api_0059__b1134774201415">+0000</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0059__ul16665627"><li id="dds_api_0059__li15772917">Response example<pre class="codeblock" id="dds_api_0059__codeblock314170531760">{
"files": [
{
"name": "43e4feaab48f11e89039fa163ebaa7e4br02.xxx",
"size": 2803,
"download_link":"https://obs.domainname.com/rdsbucket.username.1/xxxxxx",
"link_expired_time":"2018-08-016T10:15:14+0000"
}
],
"bucket": "rdsbucket.bucketname"
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0059__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0059__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_0059__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0059__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0059__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_backup_restore.html">Backup and Restoration</a></div>
</div>
</div>
View Git Blame Copy Permalink