yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/cbr/api-ref/ListBackups.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

684 lines
50 KiB
HTML
Raw Blame History

<a name="ListBackups"></a><a name="ListBackups"></a>
<h1 class="topictitle1">Querying All Backups</h1>
<div id="body1708331107508"><div class="section" id="ListBackups__section159316340415"><h4 class="sectiontitle">Function</h4><p id="ListBackups__p175944348410">This API is used to query all backups.</p>
<p id="ListBackups__p753213813417">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="ListBackups__section459433414414"><h4 class="sectiontitle">URI</h4><p id="ListBackups__p16594193420419">GET /v3/{project_id}/backups</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__table4595103419418" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListBackups__row25943341844"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListBackups__p95951334242">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListBackups__p155952348410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListBackups__p259517349412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListBackups__p125956341344">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row9595153415419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListBackups__p85951434445">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListBackups__p1359563410411">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListBackups__p25951734745">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListBackups__p175954341848">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__table18598123412417" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListBackups__row659618341940"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListBackups__p6598934447">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListBackups__p1059813411414">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListBackups__p175989347414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListBackups__p5598834241">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row159619341046"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p185981234949">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1859817341645">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p559843412416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p5598034641">Restore point ID</p>
</td>
</tr>
<tr id="ListBackups__row1859620341411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p185995343417">dec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p45991434940">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p14599163416420">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p35994341845">Dedicated cloud</p>
</td>
</tr>
<tr id="ListBackups__row115967343411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p559983410412">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p859915341841">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p2599834646">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p115992349411">Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, <strong id="ListBackups__b559919341746">2018-02-01T12:00:00Z</strong>.</p>
</td>
</tr>
<tr id="ListBackups__row959793413410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p4599183412419">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1760011341345">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1460083411415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1160063411416">Backup type, which is <strong id="ListBackups__b196006341343">backup</strong>.</p>
</td>
</tr>
<tr id="ListBackups__row85971834540"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p18600123419416">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p19600234241">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p160018341416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p460093413413">Number of records displayed per page. The value must be a positive integer.</p>
</td>
</tr>
<tr id="ListBackups__row55971234745"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1960012343415">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p6600103411417">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p106006345416">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1860020348420">ID of the last record displayed on the previous page</p>
</td>
</tr>
<tr id="ListBackups__row185976341444"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p360083417412">member_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p4600203416419">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1360016341142">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p06014344410">Backup sharing status</p>
<p id="ListBackups__p116018349419">Enumeration values:</p>
<ul id="ListBackups__ul5601334348"><li id="ListBackups__li360112344416"><p id="ListBackups__p1560163410414"><a name="ListBackups__li360112344416"></a><a name="li360112344416"></a><strong id="ListBackups__b116011934942">pending</strong></p>
</li><li id="ListBackups__li96011634847"><p id="ListBackups__p176011134344"><a name="ListBackups__li96011634847"></a><a name="li96011634847"></a><strong id="ListBackups__b1860117348410">accepted</strong></p>
</li><li id="ListBackups__li14601133411416"><p id="ListBackups__p260112341745"><a name="ListBackups__li14601133411416"></a><a name="li14601133411416"></a><strong id="ListBackups__b126018345410">rejected</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListBackups__row659733410411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1660113341647">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p11601234542">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1160118341413">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p12601934849">Backup name</p>
</td>
</tr>
<tr id="ListBackups__row195979344419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p6601103419412">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p12601173420413">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p060183411415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1060118345411">Offset value. The value must be a positive integer.</p>
</td>
</tr>
<tr id="ListBackups__row125974347415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p2060118341942">own_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1860219346411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p86026341742">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1602534748">Owning type of a backup. <strong id="ListBackups__b56021534841">private</strong> backups are queried by default.</p>
<p id="ListBackups__p960293418412">Default: <strong id="ListBackups__b460216341247">private</strong></p>
<p id="ListBackups__p146021234643">Enumeration values:</p>
<ul id="ListBackups__ul660217344412"><li id="ListBackups__li760233418418"><p id="ListBackups__p960216344412"><a name="ListBackups__li760233418418"></a><a name="li760233418418"></a><strong id="ListBackups__b1460218341848">all_granted</strong></p>
</li><li id="ListBackups__li960211341045"><p id="ListBackups__p19602173412417"><a name="ListBackups__li960211341045"></a><a name="li960211341045"></a><strong id="ListBackups__b186021341943">private</strong></p>
</li><li id="ListBackups__li13602734845"><p id="ListBackups__p126021534041"><a name="ListBackups__li13602734845"></a><a name="li13602734845"></a><strong id="ListBackups__b11602183414413">shared</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListBackups__row15970341249"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p7602113412417">parent_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p10602173416419">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p660217341741">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p3602113412418">Parent backup ID</p>
</td>
</tr>
<tr id="ListBackups__row4597034442"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1760212341419">resource_az</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p11602634542">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p13603113417413">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p9603434240">AZ-based filtering is supported.</p>
</td>
</tr>
<tr id="ListBackups__row1759715348415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p26031334744">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p860319341947">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p36035348420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p560317346412">Resource ID</p>
</td>
</tr>
<tr id="ListBackups__row15975349410"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p106033341945">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p16038349411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1660319341446">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p160311341847">Resource name</p>
</td>
</tr>
<tr id="ListBackups__row859712344413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1760318341748">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p66031534348">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1560314347415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p15603133418414">Resource type, which can be <strong id="ListBackups__b3603123418417">OS::Nova::Server</strong>, <strong id="ListBackups__b9603934644">OS::Cinder::Volume</strong>, or <strong id="ListBackups__b06031934644">OS::Sfs::Turbo</strong></p>
</td>
</tr>
<tr id="ListBackups__row1259715344419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p960411341249">sort</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p260414343411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1160418345419">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p16041234948">A group of properties separated by commas (,) and sorting directions. The value is in the format of &lt;key1&gt;[:&lt;direction&gt;],&lt;key2&gt;[:&lt;direction&gt;], where the value of direction is <strong id="ListBackups__b160418342410">asc</strong> (ascending order) or <strong id="ListBackups__b860419341940">desc</strong> (descending order). If a direction is not specified, the default sorting direction is <strong id="ListBackups__b14604103416415">desc</strong>. The value of <strong id="ListBackups__b26045341416">sort</strong> can contain a maximum of 255 characters. The key can be as follows: <strong id="ListBackups__b1604193417414">created_at</strong>, <strong id="ListBackups__b560410341048">updated_at</strong>, <strong id="ListBackups__b1760493419419">name</strong>, <strong id="ListBackups__b1560420341148">status</strong>, <strong id="ListBackups__b260417344416">protected_at</strong>, <strong id="ListBackups__b136041534849">id</strong></p>
</td>
</tr>
<tr id="ListBackups__row175975344415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p66041534944">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1160493414413">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1360414345415">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p36041734849">Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, <strong id="ListBackups__b146051734048">2018-02-01T12:00:00Z</strong>.</p>
</td>
</tr>
<tr id="ListBackups__row55971134245"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p12605193414414">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p660519345412">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p19605334944">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p160519341447">Status</p>
<p id="ListBackups__p8605183410417">When the API is called, multiple statuses can be transferred for filtering, for example, <strong id="ListBackups__b1560583417419">status=available&amp;status=error</strong>.</p>
<p id="ListBackups__p18605334340">Enumeration values:</p>
<ul id="ListBackups__ul1560516341649"><li id="ListBackups__li3605334545"><p id="ListBackups__p1360513341444"><a name="ListBackups__li3605334545"></a><a name="li3605334545"></a><strong id="ListBackups__b196051334941">available</strong></p>
</li><li id="ListBackups__li76050348410"><p id="ListBackups__p126058345417"><a name="ListBackups__li76050348410"></a><a name="li76050348410"></a><strong id="ListBackups__b186051934448">protecting</strong></p>
</li><li id="ListBackups__li1605334746"><p id="ListBackups__p66051349416"><a name="ListBackups__li1605334746"></a><a name="li1605334746"></a><strong id="ListBackups__b1960543416418">deleting</strong></p>
</li><li id="ListBackups__li260512341042"><p id="ListBackups__p1560518341947"><a name="ListBackups__li260512341042"></a><a name="li260512341042"></a><strong id="ListBackups__b14605173414410">restoring</strong></p>
</li><li id="ListBackups__li2060516341412"><p id="ListBackups__p160516343416"><a name="ListBackups__li2060516341412"></a><a name="li2060516341412"></a><strong id="ListBackups__b5605123417413">error</strong></p>
</li><li id="ListBackups__li17605334247"><p id="ListBackups__p176054341543"><a name="ListBackups__li17605334247"></a><a name="li17605334247"></a><strong id="ListBackups__b56052348416">waiting_protect</strong></p>
</li><li id="ListBackups__li160519341749"><p id="ListBackups__p76061234946"><a name="ListBackups__li160519341749"></a><a name="li160519341749"></a><strong id="ListBackups__b1560633416416">waiting_delete</strong></p>
</li><li id="ListBackups__li1860614341420"><p id="ListBackups__p136063341249"><a name="ListBackups__li1860614341420"></a><a name="li1860614341420"></a><strong id="ListBackups__b1560612341149">waiting_restore</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListBackups__row1359783412411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p18606534841">used_percent</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p860611341449">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p16606143411420">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p16606173411410">Backups are filtered based on the occupied vault capacity. The value ranges from <strong id="ListBackups__b560614341345">1</strong> to <strong id="ListBackups__b13606163419414">100</strong>. For example, if <strong id="ListBackups__b560633413417">used_percent</strong> is set to <strong id="ListBackups__b960643413412">80</strong>, all backups who occupied 80% or more of the vault capacity are displayed.</p>
</td>
</tr>
<tr id="ListBackups__row135972034740"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p260614341847">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p136065344419">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p9606133410410">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p3606183413419">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBackups__section116062346417"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListBackups__row1560611342044"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListBackups__p176071334142">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListBackups__p196077341440">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListBackups__p36071234141">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListBackups__p196070341242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row156060341147"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListBackups__p11607234648">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListBackups__p96075346415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListBackups__p26074341942">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListBackups__p14607163417410">User token</p>
<p id="ListBackups__p11607133418414">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ListBackups__b960719341548">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBackups__section1760773419416"><h4 class="sectiontitle">Response Parameters</h4><p id="ListBackups__p6607163412414"><strong id="ListBackups__b1160743414419">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__response_BackupListResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListBackups__row0608734444"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListBackups__p156081634749">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListBackups__p0608183411411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListBackups__p146081234846">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row8608163410419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p860843419415">backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p460823416412">Array of <a href="#ListBackups__response_BackupResp">BackupResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p360815345412">Backup list</p>
</td>
</tr>
<tr id="ListBackups__row2060814345414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p17608634049">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p186085341745">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p9609163410417">Number of backups</p>
</td>
</tr>
<tr id="ListBackups__row106081234545"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p136099342419">offset</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p16609173419416">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p1360911342414">Offset where the query starts</p>
<p id="ListBackups__p26099341441">Minimum: <strong id="ListBackups__b260917341740">0</strong></p>
<p id="ListBackups__p7609153414414">Default: <strong id="ListBackups__b560933416417">0</strong></p>
</td>
</tr>
<tr id="ListBackups__row11608193413416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p15609113416415">limit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p10609123412410">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p76091334541">Number of records displayed on each page</p>
<p id="ListBackups__p1560953419410">Minimum: <strong id="ListBackups__b136098341049">1</strong></p>
<p id="ListBackups__p1560913410415">Maximum: <strong id="ListBackups__b860911347412">1000</strong></p>
<p id="ListBackups__p1260916341419">Default: <strong id="ListBackups__b2609134645">1000</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListBackups__response_BackupResp"></a><a name="response_BackupResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__response_BackupResp" frame="border" border="1" rules="all"><caption><b>Table 5 </b>BackupResp</caption><thead align="left"><tr id="ListBackups__row46105341747"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListBackups__p5611934646">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListBackups__p061143419420">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListBackups__p461112341048">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row1610173411415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p76116341743">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p66111346416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p156121347416">Restore point ID</p>
</td>
</tr>
<tr id="ListBackups__row761013413420"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p18612183413413">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p661273419419">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p6612173415410">Creation time, for example, <strong id="ListBackups__b1961213418412">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ListBackups__row86102342410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p156121534447">description</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p461233412419">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p86123341948">Backup description</p>
</td>
</tr>
<tr id="ListBackups__row166103341043"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p961263410413">expired_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p14612634342">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p361293412418">Expiration time, for example, <strong id="ListBackups__b1361220341842">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ListBackups__row2610123413419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p361210341641">extend_info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p13612934549"><a href="#ListBackups__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="ListBackups__p1612163415418">Extended information</p>
</td>
</tr>
<tr id="ListBackups__row10610123410416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p136121345420">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p16612143412416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p12613134649">Backup ID</p>
</td>
</tr>
<tr id="ListBackups__row12610334447"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p16613123418413">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p10613834341">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p06136341420">Backup type, which is <strong id="ListBackups__b46138344419">backup</strong>.</p>
</td>
</tr>
<tr id="ListBackups__row166107347414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p196138341645">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p156138341849">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p961333410418">Backup name</p>
</td>
</tr>
<tr id="ListBackups__row18610173416414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p15613193420419">parent_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p106131342046">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p86131634847">Parent backup ID</p>
</td>
</tr>
<tr id="ListBackups__row106101134842"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p116131734342">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p861333415418">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p5613193412416">Project ID</p>
</td>
</tr>
<tr id="ListBackups__row261023416412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p680823415419">protected_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p380843410417">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p180843413412">Backup time</p>
</td>
</tr>
<tr id="ListBackups__row261023418418"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p108080342042">resource_az</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p188088341640">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p58093348413">Resource availability zone</p>
</td>
</tr>
<tr id="ListBackups__row861013341540"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p3809203417410">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p7809113414417">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p0809113413413">Resource ID</p>
</td>
</tr>
<tr id="ListBackups__row186111345419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p18099341041">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p17809334844">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p198091341847">Resource name</p>
</td>
</tr>
<tr id="ListBackups__row161120341042"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p1380973416420">resource_size</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p11809434349">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p38091534844">Resource size, in GB</p>
</td>
</tr>
<tr id="ListBackups__row5611153410416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p2080963417412">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p208092343416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1880913341247">Resource type, which can be <strong id="ListBackups__b188095342415">OS::Nova::Server</strong>, <strong id="ListBackups__b38093345417">OS::Cinder::Volume</strong>, or <strong id="ListBackups__b9809103415416">OS::Sfs::Turbo</strong></p>
</td>
</tr>
<tr id="ListBackups__row96117341640"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p180918347414">status</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p148091341848">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p18095342414">Backup status</p>
<p id="ListBackups__p68094340416">Enumeration values:</p>
<ul id="ListBackups__ul1480913349415"><li id="ListBackups__li1780919341045"><p id="ListBackups__p6809834444"><a name="ListBackups__li1780919341045"></a><a name="li1780919341045"></a><strong id="ListBackups__b188095341415">available</strong></p>
</li><li id="ListBackups__li78096342045"><p id="ListBackups__p980919341947"><a name="ListBackups__li78096342045"></a><a name="li78096342045"></a><strong id="ListBackups__b128095341548">protecting</strong></p>
</li><li id="ListBackups__li38091634948"><p id="ListBackups__p1280918341846"><a name="ListBackups__li38091634948"></a><a name="li38091634948"></a><strong id="ListBackups__b108095341146">deleting</strong></p>
</li><li id="ListBackups__li4809234042"><p id="ListBackups__p7809183415414"><a name="ListBackups__li4809234042"></a><a name="li4809234042"></a><strong id="ListBackups__b1580973412415">restoring</strong></p>
</li><li id="ListBackups__li168099340414"><p id="ListBackups__p138093346418"><a name="ListBackups__li168099340414"></a><a name="li168099340414"></a><strong id="ListBackups__b680911341849">error</strong></p>
</li><li id="ListBackups__li168097344417"><p id="ListBackups__p1180973410419"><a name="ListBackups__li168097344417"></a><a name="li168097344417"></a><strong id="ListBackups__b138091534344">waiting_protect</strong></p>
</li><li id="ListBackups__li78091734345"><p id="ListBackups__p68098341746"><a name="ListBackups__li78091734345"></a><a name="li78091734345"></a><strong id="ListBackups__b1080912341743">waiting_delete</strong></p>
</li><li id="ListBackups__li980919340413"><p id="ListBackups__p5809193412412"><a name="ListBackups__li980919340413"></a><a name="li980919340413"></a><strong id="ListBackups__b280943418417">waiting_restore</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListBackups__row206117341849"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p5809103415416">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p1680916346420">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p08099341248">Update time, for example, <strong id="ListBackups__b188093340413">2020-02-05T10:38:34.209782</strong></p>
</td>
</tr>
<tr id="ListBackups__row1861117343416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p18095341542">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p280917341742">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p48091134248">Vault ID</p>
</td>
</tr>
<tr id="ListBackups__row106113341414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p16809113410412">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p128091734948">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p5809103415420">Backup provider ID, which is used to distinguish backup objects. The value can be as follows:</p>
<p id="ListBackups__p1809334845"><strong id="ListBackups__b19809123416417">0daac4c5-6707-4851-97ba-169e36266b66</strong> indicates that backup objects are cloud servers; <strong id="ListBackups__b980917341148">d1603440-187d-4516-af25-121250c7cc97</strong> indicates that backup objects are cloud disks; <strong id="ListBackups__b08091034544">3f3c3220-245c-4805-b811-758870015881</strong> indicates that backup objects are SFS Turbo file systems.</p>
</td>
</tr>
<tr id="ListBackups__row166111345414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p1480903419417">children</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p38091343417">Array of <a href="#ListBackups__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="ListBackups__p12809934846">Backup list</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListBackups__response_BackupExtendInfo"></a><a name="response_BackupExtendInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__response_BackupExtendInfo" frame="border" border="1" rules="all"><caption><b>Table 6 </b>BackupExtendInfo</caption><thead align="left"><tr id="ListBackups__row26161534946"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListBackups__p1681063412410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListBackups__p118104343417">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListBackups__p20810034441">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row106173341047"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p148108342418">auto_trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p128103341845">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p5810153414413">Whether the backup is automatically generated</p>
</td>
</tr>
<tr id="ListBackups__row19617834349"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p198101134947">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p781073412415">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p881073410416">Whether the backup is a system disk backup</p>
</td>
</tr>
<tr id="ListBackups__row1461717341249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p381013416418">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p581011341049">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p381013347418">Whether the backup is an incremental backup</p>
</td>
</tr>
<tr id="ListBackups__row1761710342049"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p9810634744">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p78101734149">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p2081011341347">Snapshot ID of the disk backup</p>
</td>
</tr>
<tr id="ListBackups__row1061711341411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p28107341445">support_lld</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p1981014347411">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p168101834743">Whether to allow <strong id="ListBackups__b1581013419411">lazyloading</strong> for fast restoration</p>
</td>
</tr>
<tr id="ListBackups__row56171934245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p38104340415">supported_restore_mode</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p1081018341042">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p1781083413417">Restoration mode. Possible values are <strong id="ListBackups__b2810173417417">na</strong>, <strong id="ListBackups__b1181014341941">snapshot</strong>, and <strong id="ListBackups__b1081011341420">backup</strong>. <strong id="ListBackups__b681023416411">snapshot</strong> indicates the backup can be used to create a full-server image. <strong id="ListBackups__b681063411418">backup</strong> indicates the data is restored from backups of the EVS disks of the server. <strong id="ListBackups__b08109341644">na</strong> indicates the backup can only be used to create new resources but cannot be used for restoration.</p>
<p id="ListBackups__p158101834641">Default: <strong id="ListBackups__b481017341945">na</strong></p>
<p id="ListBackups__p108108341341">Enumeration values:</p>
<ul id="ListBackups__ul108106345418"><li id="ListBackups__li118100344414"><p id="ListBackups__p5810183417411"><a name="ListBackups__li118100344414"></a><a name="li118100344414"></a><strong id="ListBackups__b58101634147">na</strong></p>
</li><li id="ListBackups__li15810143413417"><p id="ListBackups__p2810143418418"><a name="ListBackups__li15810143413417"></a><a name="li15810143413417"></a><strong id="ListBackups__b7810734042">backup</strong></p>
</li><li id="ListBackups__li1681016340411"><p id="ListBackups__p13810143418415"><a name="ListBackups__li1681016340411"></a><a name="li1681016340411"></a><strong id="ListBackups__b1781010341545">snapshot</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListBackups__row11617134244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p981018347414">os_images_data</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p1081083419420">Array of <a href="#ListBackups__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="ListBackups__p19810134547">ID list of images created using backups</p>
</td>
</tr>
<tr id="ListBackups__row461713416411"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p581010343420">contain_system_disk</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p198101134341">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p188101234845">Whether the VM backup data contains system disk data</p>
</td>
</tr>
<tr id="ListBackups__row106170349419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p1981018341545">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p181020341413">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p9810183411418">Whether the backup is encrypted</p>
</td>
</tr>
<tr id="ListBackups__row861717341549"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p178101634146">system_disk</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p0810193412415">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p138101934348">Whether the disk is a system disk</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListBackups__response_ImageData"></a><a name="response_ImageData"></a><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__response_ImageData" frame="border" border="1" rules="all"><caption><b>Table 7 </b>ImageData</caption><thead align="left"><tr id="ListBackups__row156197342419"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListBackups__p68111634647">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListBackups__p181163411415">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListBackups__p1681115349420">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row156191934145"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListBackups__p16811934445">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListBackups__p1281110344417">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListBackups__p9811173415417">Image ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBackups__section58121934943"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListBackups__screen17812193412418">GET https://{endpoint}/v3/{project_id}/backups</pre>
</div>
<div class="section" id="ListBackups__section1281243413415"><h4 class="sectiontitle">Example Responses</h4><p id="ListBackups__p1981218341646"><strong id="ListBackups__b16812193417415">Status code: 200</strong></p>
<p id="ListBackups__p14812173416413">OK</p>
<pre class="screen" id="ListBackups__screen881219342414">{
"count" : 2,
"backups" : [ {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
"updated_at" : "2020-02-21T07:07:25.114+00:00",
"vault_id" : "cca85ea5-00a4-418d-9222-bd83985bc515",
"id" : "b1c4afd9-e7a6-4888-9010-c2bac3aa7910",
"resource_az" : "br-iaas-odin1a",
"image_type" : "backup",
"resource_id" : "1a503932-ee8f-4dd5-8248-8dfb57e584c5",
"resource_size" : 40,
"children" : [ ],
"extend_info" : {
"auto_trigger" : true,
"supported_restore_mode" : "backup",
"contain_system_disk" : true,
"support_lld" : true,
"system_disk" : false
},
"project_id" : "0605767b5780d5762fc5c0118072a564",
"status" : "available",
"resource_name" : "test001-02",
"description" : "",
"expired_at" : "2020-05-21T07:00:54.060+00:00",
"name" : "autobk_b629",
"created_at" : "2020-02-21T07:00:54.065+00:00",
"resource_type" : "OS::Nova::Server"
}, {
"provider_id" : "d1603440-187d-4516-af25-121250c7cc97",
"checkpoint_id" : "f64c351f-769f-4c04-8806-fd90a59e9b12",
"updated_at" : "2020-02-21T07:09:37.767+00:00",
"vault_id" : "79bd9daa-884f-4f84-b8fe-235d58cd927d",
"id" : "5606aab5-2dc2-4498-8144-dc848d099af5",
"resource_az" : "br-iaas-odin1a",
"image_type" : "backup",
"resource_id" : "54f7ccbc-072f-4ec5-a7b7-b24dabdb4539",
"resource_size" : 40,
"children" : [ ],
"extend_info" : {
"auto_trigger" : true,
"snapshot_id" : "e3def9a8-e4b4-4c12-b132-f4ba8ce9a34f",
"bootable" : true,
"support_lld" : true,
"encrypted" : false,
"system_disk" : false
},
"project_id" : "0605767b5780d5762fc5c0118072a564",
"status" : "available",
"resource_name" : "qsy_000",
"description" : "",
"expired_at" : "2020-03-22T07:00:34.878+00:00",
"name" : "autobk_6809",
"created_at" : "2020-02-21T07:00:34.882+00:00",
"resource_type" : "OS::Cinder::Volume"
} ]
}</pre>
</div>
<div class="section" id="ListBackups__section2813113413411"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListBackups__row176271534845"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListBackups__p3813163417419">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListBackups__p28131634549">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListBackups__row0627133411412"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBackups__p381318345415">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBackups__p581393416416">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListBackups__section1381310341842"><h4 class="sectiontitle">Error Codes</h4><p id="ListBackups__p14813734746">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