yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
de9f8a7cc5b4e61816cbd4e52cc108c5f9fc3b4c
doc-exports/docs/cbr/api-ref/ShowBackup.html
weihongmin1 77581a0230 CBR API 0620 Version 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2025-06-25 09:41:36 +00:00

443 lines
31 KiB
HTML
Raw Blame History

<a name="ShowBackup"></a><a name="ShowBackup"></a>
<h1 class="topictitle1">Querying a Specified Backup</h1>
<div id="body1708331107508"><div class="section" id="ShowBackup__section37827343418"><h4 class="sectiontitle">Function</h4><p id="ShowBackup__p17826341147">This API is used to query the backup of a specific ID.</p>
<p id="ShowBackup__p1164817381754">If you want to create a backup, <a href="https://docs.otc.t-systems.com/api/cbr/CreateCheckpoint.html" target="_blank" rel="noopener noreferrer">create a Restore Point</a>.</p>
</div>
<div class="section" id="ShowBackup__section187823342414"><h4 class="sectiontitle">URI</h4><p id="ShowBackup__p11782103416414">GET /v3/{project_id}/backups/{backup_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__table15783434347" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowBackup__row1378318340418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowBackup__p9783113419419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowBackup__p17783143411419">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowBackup__p478311345416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowBackup__p197831234040">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row1478313413419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowBackup__p19783034142">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowBackup__p1078315341149">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowBackup__p97847341414">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowBackup__p207841134548">Backup ID</p>
</td>
</tr>
<tr id="ShowBackup__row11783123419413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowBackup__p9784143415415">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowBackup__p8784934741">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowBackup__p147841934342">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowBackup__p8784173412410">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBackup__section27841034341"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowBackup__row5784134246"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowBackup__p1578553413418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowBackup__p167858341448">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowBackup__p27851341646">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowBackup__p77856348415">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row197841349414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowBackup__p178517346414">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowBackup__p1678510341146">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowBackup__p1378511341146">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowBackup__p1078519341645">User token</p>
<p id="ShowBackup__p17851034543">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ShowBackup__b10785183416418">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBackup__section9785173413416"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowBackup__p7785173419412"><strong id="ShowBackup__b278514341340">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__response_BackupGetResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowBackup__row117861434246"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowBackup__p678618346412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowBackup__p157865343413">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowBackup__p2786203413417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row1078618341846"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowBackup__p197861534344">backup</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowBackup__p6786034842"><a href="#ShowBackup__response_BackupResp">BackupResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ShowBackup__p5786103411411">Backup</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowBackup__response_BackupResp"></a><a name="response_BackupResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__response_BackupResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>BackupResp</caption><thead align="left"><tr id="ShowBackup__row107871734146"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowBackup__p187886342415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowBackup__p4788234340">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowBackup__p57881334242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row578718341147"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p5788834940">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p11788234849">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p47881341940">Restore point ID</p>
</td>
</tr>
<tr id="ShowBackup__row187871234641"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p478911342414">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p37891341447">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p2078913346412">Creation time, for example, <strong id="ShowBackup__b167894342417">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ShowBackup__row1178716341446"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p2078912341849">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p12789163410415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p378915342416">Backup description</p>
</td>
</tr>
<tr id="ShowBackup__row37871734441"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1478913415416">expired_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p13789134141">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1978953417419">Expiration time, for example, <strong id="ShowBackup__b1878915343412">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ShowBackup__row8787163413414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1978919341441">extend_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p67891834548"><a href="#ShowBackup__response_BackupExtendInfo">BackupExtendInfo</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p87891234244">Extended information</p>
</td>
</tr>
<tr id="ShowBackup__row0787183412413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p17891634047">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p678918340416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p179043411414">Backup ID</p>
</td>
</tr>
<tr id="ShowBackup__row1978714341643"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p17901634342">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p579093413411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p67903342418">Backup type, which is <strong id="ShowBackup__b9790183418417">backup</strong>.</p>
</td>
</tr>
<tr id="ShowBackup__row1578713347411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p17903341347">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p1790153420416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p167901934848">Backup name</p>
</td>
</tr>
<tr id="ShowBackup__row147873347412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p177904341147">parent_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p14790123414417">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p779014341410">Parent backup ID</p>
</td>
</tr>
<tr id="ShowBackup__row167874344419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p87902034946">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p37901834741">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p77906344416">Project ID</p>
</td>
</tr>
<tr id="ShowBackup__row2078703415417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p27901234845">protected_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p87911334544">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p57911434749">Backup time</p>
</td>
</tr>
<tr id="ShowBackup__row978713416419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p127916344416">resource_az</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p37914348410">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1779120341547">Resource availability zone</p>
</td>
</tr>
<tr id="ShowBackup__row1878783415419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1779111341342">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p779133418417">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p07918344413">Resource ID</p>
</td>
</tr>
<tr id="ShowBackup__row1078710341844"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1579110340415">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p17916341142">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p079133415419">Resource name</p>
</td>
</tr>
<tr id="ShowBackup__row1278717349419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p5791834240">resource_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p117911534348">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1379143413417">Resource size, in GB</p>
</td>
</tr>
<tr id="ShowBackup__row167882346411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p157917341241">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p7792143417410">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1679219341943">Resource type, which can be <strong id="ShowBackup__b37921234141">OS::Nova::Server</strong>, <strong id="ShowBackup__b147921634242">OS::Cinder::Volume</strong>, or <strong id="ShowBackup__b479210341143">OS::Sfs::Turbo</strong></p>
</td>
</tr>
<tr id="ShowBackup__row9788143414414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p19792103413416">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p4792123414411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1479263413411">Backup status</p>
<p id="ShowBackup__p1879219346412">Enumeration values:</p>
<ul id="ShowBackup__ul13792133420414"><li id="ShowBackup__li1479215346417"><p id="ShowBackup__p1879216341146"><a name="ShowBackup__li1479215346417"></a><a name="li1479215346417"></a><strong id="ShowBackup__b1792934945">available</strong></p>
</li><li id="ShowBackup__li1379273417414"><p id="ShowBackup__p1279217341849"><a name="ShowBackup__li1379273417414"></a><a name="li1379273417414"></a><strong id="ShowBackup__b4792183413414">protecting</strong></p>
</li><li id="ShowBackup__li1879211344418"><p id="ShowBackup__p3792193416418"><a name="ShowBackup__li1879211344418"></a><a name="li1879211344418"></a><strong id="ShowBackup__b37921341641">deleting</strong></p>
</li><li id="ShowBackup__li11792234048"><p id="ShowBackup__p1479215341941"><a name="ShowBackup__li11792234048"></a><a name="li11792234048"></a><strong id="ShowBackup__b2792103411410">restoring</strong></p>
</li><li id="ShowBackup__li879219341044"><p id="ShowBackup__p97921734343"><a name="ShowBackup__li879219341044"></a><a name="li879219341044"></a><strong id="ShowBackup__b57921534149">error</strong></p>
</li><li id="ShowBackup__li10793123420415"><p id="ShowBackup__p6793103410418"><a name="ShowBackup__li10793123420415"></a><a name="li10793123420415"></a><strong id="ShowBackup__b117931634947">waiting_protect</strong></p>
</li><li id="ShowBackup__li1679316341845"><p id="ShowBackup__p1979311342415"><a name="ShowBackup__li1679316341845"></a><a name="li1679316341845"></a><strong id="ShowBackup__b279314341341">waiting_delete</strong></p>
</li><li id="ShowBackup__li10793934740"><p id="ShowBackup__p20793133417418"><a name="ShowBackup__li10793934740"></a><a name="li10793934740"></a><strong id="ShowBackup__b1679318341347">waiting_restore</strong></p>
</li></ul>
</td>
</tr>
<tr id="ShowBackup__row278816341249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p20793234545">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p679316343413">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p379319345418">Update time, for example, <strong id="ShowBackup__b12793143415415">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ShowBackup__row57886342411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p67933341142">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p27938341945">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p57931334844">Vault ID</p>
</td>
</tr>
<tr id="ShowBackup__row0788934446"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1879418344416">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p117943341340">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p147945349419">Backup provider ID, which is used to distinguish backup objects. The value can be as follows:</p>
<p id="ShowBackup__p77945345416"><strong id="ShowBackup__b37941834541">0daac4c5-6707-4851-97ba-169e36266b66</strong> indicates that backup objects are cloud servers; <strong id="ShowBackup__b127941634842">d1603440-187d-4516-af25-121250c7cc97</strong> indicates that backup objects are cloud disks; <strong id="ShowBackup__b97948341419">3f3c3220-245c-4805-b811-758870015881</strong> indicates that backup objects are SFS Turbo file systems.</p>
</td>
</tr>
<tr id="ShowBackup__row137887342049"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowBackup__p1379419341646">children</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowBackup__p579414349415">Array of <a href="#ShowBackup__response_BackupResp">BackupResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowBackup__p1579483416410">Backup list</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowBackup__response_BackupExtendInfo"></a><a name="response_BackupExtendInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__response_BackupExtendInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>BackupExtendInfo</caption><thead align="left"><tr id="ShowBackup__row279519347417"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowBackup__p1979693414411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowBackup__p6796634946">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowBackup__p1879619341540">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row179517341440"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p19796103410411">auto_trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p117966341941">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p107960346411">Whether the backup is automatically generated</p>
</td>
</tr>
<tr id="ShowBackup__row87959341242"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p15796834243">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p979633418412">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p77962341643">Whether the backup is a system disk backup</p>
</td>
</tr>
<tr id="ShowBackup__row279518348414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p147964347410">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p779619341546">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p47962341349">Whether the backup is an incremental backup</p>
</td>
</tr>
<tr id="ShowBackup__row479533414410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p27961134548">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p97964341241">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p6796534341">Snapshot ID of the disk backup</p>
</td>
</tr>
<tr id="ShowBackup__row177951934943"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p1579643414416">support_lld</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p3796153414414">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p1479719341043">Whether to allow <strong id="ShowBackup__b1679773411417">lazyloading</strong> for fast restoration</p>
</td>
</tr>
<tr id="ShowBackup__row379523414419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p179793410419">supported_restore_mode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p3797834748">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p177972034743">Restoration mode. Possible values are <strong id="ShowBackup__b379711348415">na</strong>, <strong id="ShowBackup__b1797434247">snapshot</strong>, and <strong id="ShowBackup__b177971534245">backup</strong>. <strong id="ShowBackup__b12797434945">snapshot</strong> indicates the backup can be used to create a full-server image. <strong id="ShowBackup__b679710340414">backup</strong> indicates the data is restored from backups of the EVS disks of the server. <strong id="ShowBackup__b1179710341949">na</strong> indicates the backup can only be used to create new resources but cannot be used for restoration.</p>
<p id="ShowBackup__p197971934848">Default: <strong id="ShowBackup__b77979340411">na</strong></p>
<p id="ShowBackup__p97971342040">Enumeration values:</p>
<ul id="ShowBackup__ul07979346411"><li id="ShowBackup__li5797734848"><p id="ShowBackup__p1879717341741"><a name="ShowBackup__li5797734848"></a><a name="li5797734848"></a><strong id="ShowBackup__b13797153415418">na</strong></p>
</li><li id="ShowBackup__li679793414413"><p id="ShowBackup__p079711349415"><a name="ShowBackup__li679793414413"></a><a name="li679793414413"></a><strong id="ShowBackup__b9797193411411">backup</strong></p>
</li><li id="ShowBackup__li97978341144"><p id="ShowBackup__p579743416411"><a name="ShowBackup__li97978341144"></a><a name="li97978341144"></a><strong id="ShowBackup__b147978341245">snapshot</strong></p>
</li></ul>
</td>
</tr>
<tr id="ShowBackup__row1879512343417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p579717341345">os_images_data</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p879715341845">Array of <a href="#ShowBackup__response_ImageData">ImageData</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p1479723410413">ID list of images created using backups</p>
</td>
</tr>
<tr id="ShowBackup__row3795934941"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p979715345413">contain_system_disk</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p1979743414419">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p179811341849">Whether the VM backup data contains system disk data</p>
</td>
</tr>
<tr id="ShowBackup__row37958347412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p27981634842">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p13798133419413">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p379873416419">Whether the backup is encrypted</p>
</td>
</tr>
<tr id="ShowBackup__row12795134742"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowBackup__p7798163411420">system_disk</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowBackup__p13798193412419">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowBackup__p1798193411419">Whether the disk is a system disk</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowBackup__response_ImageData"></a><a name="response_ImageData"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__response_ImageData" frame="border" border="1" rules="all"><caption><b>Table 6 </b>ImageData</caption><thead align="left"><tr id="ShowBackup__row279918341740"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowBackup__p177998341743">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowBackup__p07998345411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowBackup__p77996348416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row27997345413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowBackup__p107991134040">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowBackup__p117996341244">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowBackup__p37991341345">Image ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBackup__section1496814346415"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowBackup__screen129689344410">GET https://{endpoint}/v3/{project_id}/backups/{backup_id}</pre>
</div>
<div class="section" id="ShowBackup__section196812341442"><h4 class="sectiontitle">Example Responses</h4><p id="ShowBackup__p1896816344411"><strong id="ShowBackup__b79681734148">Status code: 200</strong></p>
<p id="ShowBackup__p79681834148">OK</p>
<pre class="screen" id="ShowBackup__screen796816341549">{
"backup" : {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
"enterprise_project_id" : 0,
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
"id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
"resource_az" : "az1.dc1",
"image_type" : "backup",
"resource_id" : "94eba8b2-acc9-4d82-badc-127144cc5526",
"resource_size" : 40,
"children" : [ {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"checkpoint_id" : "8b0851a8-adf3-4f4c-a914-dead08bf9664",
"vault_id" : "3b5816b5-f29c-4172-9d9a-76c719a659ce",
"id" : "5d822633-2bbf-4af8-a16e-5ab1c7705235",
"image_type" : "backup",
"resource_id" : "eccbcfdd-f843-4bbb-b2c0-a5ce861f9376",
"resource_size" : 40,
"children" : [ ],
"parent_id" : "6df2b54c-dd62-4059-a07c-1b8f24f2725d",
"extend_info" : {
"auto_trigger" : true,
"snapshot_id" : "5230a977-1a94-4092-8edd-519303a44cda",
"bootable" : true,
"encrypted" : true
},
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
"status" : "available",
"resource_name" : "ecs-1f0f-0002",
"name" : "autobk_a843_ecs-1f0f-0002",
"created_at" : "2019-05-10T07:59:59.451+00:00",
"resource_type" : "OS::Cinder::Volume"
} ],
"extend_info" : {
"auto_trigger" : true,
"supported_restore_mode" : "backup",
"contain_system_disk" : true,
"support_lld" : true
},
"project_id" : "4229d7a45436489f8c3dc2b1d35d4987",
"status" : "available",
"resource_name" : "ecs-1f0f-0002",
"description" : "backup_description",
"name" : "backup_name",
"created_at" : "2019-05-10T07:59:12.085+00:00",
"resource_type" : "OS::Nova::Server"
}
}</pre>
</div>
<div class="section" id="ShowBackup__section17969113416420"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowBackup__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowBackup__row28083347416"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowBackup__p2096923417420">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowBackup__p69697341418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowBackup__row98081834143"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowBackup__p99695341941">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowBackup__p1296943415417">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowBackup__section796914341411"><h4 class="sectiontitle">Error Codes</h4><p id="ShowBackup__p2096963410416">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000004.html">Backups</a></div>
</div>
</div>
View Git Blame Copy Permalink