forked from docs/doc-exports
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
656 lines
47 KiB
HTML
656 lines
47 KiB
HTML
<a name="ListBackups"></a><a name="ListBackups"></a>
|
|
|
|
<h1 class="topictitle1">Querying All Backups</h1>
|
|
<div id="body197351617151"><div class="section" id="ListBackups__section473581171512"><h4 class="sectiontitle">Function</h4><p id="ListBackups__p1473651151510">This API is used to query all backups.</p>
|
|
</div>
|
|
<div class="section" id="ListBackups__section1773611110159"><h4 class="sectiontitle">URI</h4><p id="ListBackups__p197361615153">GET /v3/{project_id}/backups</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__table6740151191512" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListBackups__row1973815161510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListBackups__p1374010191511">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListBackups__p187411314153">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListBackups__p77414151510">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListBackups__p174231131511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row14739111161517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListBackups__p13742131161510">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListBackups__p67432017153">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListBackups__p127438161520">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListBackups__p374410111515">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListBackups__table107497161516" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListBackups__row187457161514"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListBackups__p137491218158">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListBackups__p475014117158">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListBackups__p197511217156">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListBackups__p1575491111512">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row3745814152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p67553119154">checkpoint_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1975620111511">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1775612119158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p13757121141519">Restore point ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row174619119151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p3757612154">dec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1175716112153">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p13758416156">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p167589141516">Dedicated cloud</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row77468114152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1275910119153">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p2075918113158">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p776061161516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p11760161191512">Time when the backup ends, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, <strong id="ListBackups__b17601918152">2018-02-01T12:00:00Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row974641121513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p1076215115154">image_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1076311141518">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1276316116152">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p67638141514">Backup type, which is <strong id="ListBackups__b10764151201519">backup</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1746412150"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p876441131518">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p2764112151">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p77659120151">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p177655171518">Number of records displayed per page. The value must be a positive integer.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row27462113155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p187656111517">marker</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p197667112150">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p77667111516">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1176791101518">ID of the last record displayed on the previous page</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row374613171515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p10767111181515">member_status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p27671417158">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p4768131191513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p2076915141513">Backup sharing status</p>
|
|
<p id="ListBackups__p1276915119151">Enumeration values:</p>
|
|
<ul id="ListBackups__ul876914171513"><li id="ListBackups__li107706113157"><strong id="ListBackups__b6770519157">pending</strong></li><li id="ListBackups__li577010120156"><strong id="ListBackups__b07714111155">accepted</strong></li><li id="ListBackups__li9771815157"><strong id="ListBackups__b157712110159">rejected</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1074612117159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p67711815153">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1877201111516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p477219171514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1277310191516">Backup name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row57467110151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p107733111511">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p20773151101516">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p207741019153">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1577551101513">Offset value. The value must be a positive integer.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row574711171514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p15775411158">own_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p37762110156">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p07761120153">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p477711112155">Owning type of a backup. <strong id="ListBackups__b1877781151519">private</strong> backups are queried by default.</p>
|
|
<p id="ListBackups__p9777131171512">Default: <strong id="ListBackups__b97779131517">private</strong></p>
|
|
<p id="ListBackups__p477781151518">Enumeration values:</p>
|
|
<ul id="ListBackups__ul57789161519"><li id="ListBackups__li14778181121515"><strong id="ListBackups__b147781011152">all_granted</strong></li><li id="ListBackups__li157785121512"><strong id="ListBackups__b47791113157">private</strong></li><li id="ListBackups__li20779417156"><strong id="ListBackups__b107798118151">shared</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row207471819153"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p187791019151">parent_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p578010116155">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p378017131513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p18781151161520">Parent backup ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row12747171101518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p4781191161512">resource_az</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p167821317157">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p10782616153">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p3786111151511">AZ-based filtering is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1074791131516"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p67878110159">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p77883191510">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1778831131511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p15789915158">Resource ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row4747181191511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p4790510152">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p37901161513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1679121141511">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p7792161101514">Resource name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1174715110154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p17792201161512">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p47929191515">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p167969121519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p7796121101515">Resource type, which can be <strong id="ListBackups__b137971114154">OS::Nova::Server</strong>, <strong id="ListBackups__b579712118153">OS::Cinder::Volume</strong>, or <strong id="ListBackups__b17971513157">OS::Sfs::Turbo</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row474716191510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p480018131517">sort</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p14800121101519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p6801918152">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p8324143641219">A group of properties separated by commas (,) and sorting directions. The value format is <key1>[:<direction>],<key2>[:<direction>], where the value of direction is <strong id="ListBackups__b225118312146">asc</strong> (in ascending order) or <strong id="ListBackups__b9876219141413">desc</strong> (in descending order). If the parameter direction is not specified, the default sorting direction is <strong id="ListBackups__b974614015148">desc</strong>. The value of <strong id="ListBackups__b893814853211">sort</strong> contains a maximum of 255 characters.The value range of key is as follows: <strong id="ListBackups__b188034131518">[created_at, updated_at, name, status, protected_at, id]</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row374715113154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p58040112153">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p1480410181519">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p1080417118158">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p1180515131512">Time when the backup starts, in %YYYY-%mm-%ddT%HH:%MM:%SSZ format. For example, <strong id="ListBackups__b580591111517">2018-02-01T12:00:00Z</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row17748913152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p118051210158">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p128061211154">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p2806121171512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p158071012155">Status When the API is called, multiple statuses can be transferred for filtering, for example, <strong id="ListBackups__b138074171511">status=available&status=error</strong>.</p>
|
|
<p id="ListBackups__p88072119158">Enumeration values:</p>
|
|
<ul id="ListBackups__ul17807119150"><li id="ListBackups__li680771131518"><strong id="ListBackups__b4808151151516">available</strong></li><li id="ListBackups__li13808713159"><strong id="ListBackups__b118087112154">protecting</strong></li><li id="ListBackups__li16808181141515"><strong id="ListBackups__b198081912158">deleting</strong></li><li id="ListBackups__li180891141511"><strong id="ListBackups__b1980919116153">restoring</strong></li><li id="ListBackups__li19809191191515"><strong id="ListBackups__b1080911110151">error</strong></li><li id="ListBackups__li15810515157"><strong id="ListBackups__b981014118156">waiting_protect</strong></li><li id="ListBackups__li108101312151"><strong id="ListBackups__b781017141511">waiting_delete</strong></li><li id="ListBackups__li381018110150"><strong id="ListBackups__b16811101201519">waiting_restore</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row7748516157"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p78111171519">used_percent</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p168117111153">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p781217191517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p16812512150">Backups are filtered based on the occupied vault capacity. The value ranges from <strong id="ListBackups__b58128151520">1</strong> to <strong id="ListBackups__b128124113152">100</strong>. For example, if <strong id="ListBackups__b3812121121516">used_percent</strong> is set to <strong id="ListBackups__b1781217115152">80</strong>, all backups who occupied 80% or more of the vault capacity are displayed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row97481111155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListBackups__p5813131151511">vault_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListBackups__p178131319154">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListBackups__p881313120155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListBackups__p781410111155">Vault ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListBackups__section18815101131514"><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__row1081513111152"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListBackups__p38193115155">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListBackups__p15819713156">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListBackups__p1082015121519">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListBackups__p1782012181515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row13816811159"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListBackups__p168215171515">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListBackups__p182117117158">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListBackups__p1882131121512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListBackups__p2082281151518">User token The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ListBackups__b118226116156">X-Subject-Token</strong> in the response header is the user token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListBackups__section12822015152"><h4 class="sectiontitle">Response Parameters</h4><p id="ListBackups__p1082316101512"><strong id="ListBackups__b11823161101515">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__row08231818154"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListBackups__p582517191512">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListBackups__p982551151515">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListBackups__p1582612116155">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row38241419152"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p1882631161513">backups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p1882661171519">Array of <a href="#ListBackups__response_BackupResp">BackupResp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p15827915157">Backup list</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row11824201141510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p1482715118158">count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p482831181510">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p1828171191511">Number of backups</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row88242131510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p982914171513">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p382911131519">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p383071141512">Offset where the query starts</p>
|
|
<p id="ListBackups__p283011191514">Minimum: <strong id="ListBackups__b68301215152">0</strong></p>
|
|
<p id="ListBackups__p6831151111518">Default: <strong id="ListBackups__b48310111515">0</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row08241110151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListBackups__p2832101131515">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListBackups__p18351114156">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListBackups__p2083619115159">Number of records displayed on each page</p>
|
|
<p id="ListBackups__p188367117158">Minimum: <strong id="ListBackups__b383661131515">1</strong></p>
|
|
<p id="ListBackups__p68365191512">Maximum: <strong id="ListBackups__b383617131517">1000</strong></p>
|
|
<p id="ListBackups__p198379171515">Default: <strong id="ListBackups__b10837111161511">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__row1583861101511"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListBackups__p18438181513">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListBackups__p1584631141519">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListBackups__p384612113156">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row20838511153"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p984741131515">checkpoint_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p084720151517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p8848115152">Restore point ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row168381411155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p128491115152">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p11849617151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p14850511155">Creation time, for example, <strong id="ListBackups__b18501110152">2020-02-05T10:38:34.209782</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row183810171515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p13850161131512">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p158515121517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1085114115158">Backup description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row2083812118154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p585111161510">expired_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p385210141514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p2852141201512">Expiration time, for example, <strong id="ListBackups__b5852191181515">2020-02-05T10:38:34.209782</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1683981111515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p2853213151">extend_info</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p9853121141513"><a href="#ListBackups__response_BackupExtendInfo">BackupExtendInfo</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1485451121512">Extended information</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1383916114158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p68546115150">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p1085415181517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p58558111154">Backup ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row188395181510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p98558117150">image_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p13856131131518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p98561815153">Backup type, which is <strong id="ListBackups__b48567116155">backup</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row8839111111513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p168577161517">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p88578151518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p785801181517">Backup name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1083991181517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p148585111158">parent_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p198587121517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1685916181512">Parent backup ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1083941161520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p286071161517">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p88604118154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p88601011151">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row48392014158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p16861414156">protected_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p786116131512">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p122271626157">Backup time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row168406119150"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p16228324156">resource_az</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p02286216159">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p82281529156">Resource availability zone</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row58401814158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p1322872151516">resource_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p7228623153">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p02281424151">Resource ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row128401118158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p172297251511">resource_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p02291727154">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p16229122141518">Resource name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row188406131515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p52294212159">resource_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p822912191516">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1522920221519">Resource size, in GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row1284010151510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p192291223154">resource_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p1022972131519">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p162291721159">Resource type, which can be <strong id="ListBackups__b192305220154">OS::Nova::Server</strong>, <strong id="ListBackups__b122307211511">OS::Cinder::Volume</strong>, or <strong id="ListBackups__b62302261519">OS::Sfs::Turbo</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row584115161511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p1523082111510">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p102309210155">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p82301226159">Backup status</p>
|
|
<p id="ListBackups__p13230142131516">Enumeration values:</p>
|
|
<ul id="ListBackups__ul42301121158"><li id="ListBackups__li132301224155"><strong id="ListBackups__b52307281518">available</strong></li><li id="ListBackups__li112301201514"><strong id="ListBackups__b12231122131513">protecting</strong></li><li id="ListBackups__li202318211516"><strong id="ListBackups__b122314212153">deleting</strong></li><li id="ListBackups__li42318291513"><strong id="ListBackups__b52311223154">restoring</strong></li><li id="ListBackups__li92326201510"><strong id="ListBackups__b0232172101516">error</strong></li><li id="ListBackups__li1023213241515"><strong id="ListBackups__b142321121154">waiting_protect</strong></li><li id="ListBackups__li423218221511"><strong id="ListBackups__b1323215210155">waiting_delete</strong></li><li id="ListBackups__li16233628150"><strong id="ListBackups__b1323382171517">waiting_restore</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row13841151121515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p132331421150">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p1523319214151">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p102331829157">Update time, for example, <strong id="ListBackups__b172331823151">2020-02-05T10:38:34.209782</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row784131151519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p72331231519">vault_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p823312214156">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p1223392151513">Vault ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row98429115151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p20234927156">provider_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p1423472101518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p14235425155">Backup provider ID, which is used to distinguish backup objects. The value can be as follows:</p>
|
|
<p id="ListBackups__p3235425154"><strong id="ListBackups__b823513211152">0daac4c5-6707-4851-97ba-169e36266b66</strong> indicates that backup objects are cloud servers; <strong id="ListBackups__b12235429150">d1603440-187d-4516-af25-121250c7cc97</strong> indicates that backup objects are cloud disks; <strong id="ListBackups__b12358281512">3f3c3220-245c-4805-b811-758870015881</strong> indicates that backup objects are SFS Turbo file systems.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row128423112155"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListBackups__p72358212154">children</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListBackups__p92355221517">Array of <a href="#ListBackups__response_BackupResp">BackupResp</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListBackups__p223520219159">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__row1688210112156"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="ListBackups__p22365221513">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="ListBackups__p112361524154">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="ListBackups__p16236929157">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row68822117156"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p223617216155">auto_trigger</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p192376291511">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p723713241510">Whether the backup is automatically generated</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row17882121141518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p2237025150">bootable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p8237142131518">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p1523710261510">Whether the backup is a system disk backup</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row488210191518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p11237152141520">incremental</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p623720214156">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p15238172181510">Whether the backup is an incremental backup</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row688211111157"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p423802151512">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p1238102111517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p92396231516">Snapshot ID of the disk backup</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row68829111153"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p0239112111518">support_lld</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p62391928152">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p2024082111517">Whether to allow <strong id="ListBackups__b1724016214156">lazyloading</strong> for fast restoration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row15882121101519"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p9240112161514">supported_restore_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p92406211517">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p1824018210157">Restoration mode. Possible values are <strong id="ListBackups__b2024072181517">na</strong>, <strong id="ListBackups__b124017211515">snapshot</strong>, and <strong id="ListBackups__b424017215156">backup</strong>. <strong id="ListBackups__b0240142101510">snapshot</strong> indicates the backup can be used to create a full-server image. <strong id="ListBackups__b19240182161518">backup</strong> indicates the data is restored from backups of the EVS disks of the server. <strong id="ListBackups__b172401219154">na</strong> indicates the backup can only be used to create new resources but cannot be used for restoration.</p>
|
|
<p id="ListBackups__p1724116213157">Default: <strong id="ListBackups__b162417201512">na</strong></p>
|
|
<p id="ListBackups__p924112141510">Enumeration values:</p>
|
|
<ul id="ListBackups__ul162419281516"><li id="ListBackups__li15241722159"><strong id="ListBackups__b72411217150">na</strong></li><li id="ListBackups__li102411529152"><strong id="ListBackups__b12418231520">backup</strong></li><li id="ListBackups__li132413216151"><strong id="ListBackups__b824152201518">snapshot</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row15882161161515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p18242162171518">os_images_data</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p124218241511">Array of <a href="#ListBackups__response_ImageData">ImageData</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p324262101511">ID list of images created using backups</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row88821416154"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p122425251516">contain_system_disk</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p92427210157">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p2024232181517">Whether the VM backup data contains system disk data</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row10883151201518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p1024217213153">encrypted</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p9242521151">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p1224313213159">Whether the backup is encrypted</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="ListBackups__row788318115151"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListBackups__p16243723155">system_disk</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListBackups__p20243824152">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListBackups__p824320211157">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__row4898171161518"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="ListBackups__p72440231518">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="ListBackups__p202448218158">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="ListBackups__p92445218150">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row38987113158"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListBackups__p9244925153">image_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListBackups__p162442027152">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListBackups__p1924411217159">Image ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListBackups__section125732101511"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListBackups__screen6257621151">GET https://{endpoint}/v3/{project_id}/backups</pre>
|
|
</div>
|
|
<div class="section" id="ListBackups__section82572210156"><h4 class="sectiontitle">Example Responses</h4><p id="ListBackups__p9257112111516"><strong id="ListBackups__b4257325153">Status code: 200</strong></p>
|
|
<p id="ListBackups__p132580251512">OK</p>
|
|
<pre class="screen" id="ListBackups__screen19258182141517">{
|
|
"count" : 2,
|
|
"backups" : [ {
|
|
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
|
|
"checkpoint_id" : "1fced58b-2a31-4851-bcbb-96216f83ce99",
|
|
"updated_at" : "2020-02-21T07:07:25.113761",
|
|
"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.060493",
|
|
"name" : "autobk_b629",
|
|
"created_at" : "2020-02-21T07:00:54.065135",
|
|
"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.767084",
|
|
"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.877896",
|
|
"name" : "autobk_6809",
|
|
"created_at" : "2020-02-21T07:00:34.882174",
|
|
"resource_type" : "OS::Cinder::Volume"
|
|
} ]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="ListBackups__section1326252191517"><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__row49521319152"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListBackups__p8263625152">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__p9263122121520">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="ListBackups__row18952619159"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListBackups__p1326312291512">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListBackups__p17264132171519">OK</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="ListBackups__section2264182161515"><h4 class="sectiontitle">Error Codes</h4><p id="ListBackups__p1026411215154">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_300000005.html">Backups</a></div>
|
|
</div>
|
|
</div>
|
|
|