vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/vbs/api-ref/en-us_topic_0020237259.html
Wei, Hongmin 63123ef1be VBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-25 07:47:39 +00:00

621 lines
48 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0020237259"></a><a name="EN-US_TOPIC_0020237259"></a>
<h1 class="topictitle1">Querying Details About VBS Backups (Native OpenStack API)</h1>
<div id="body48704899"><div class="section" id="EN-US_TOPIC_0020237259__section38423121"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020237259__p52782726">This API is used to query the details about VBS backups.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020237259__section10263773"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0020237259__ul47542385"><li id="EN-US_TOPIC_0020237259__li25228285">URI format<p id="EN-US_TOPIC_0020237259__p30225241"><a name="EN-US_TOPIC_0020237259__li25228285"></a><a name="li25228285"></a>GET /v2/{project_id}/backups/detail</p>
</li><li id="EN-US_TOPIC_0020237259__li3591713">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table32325424" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row59286834"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="EN-US_TOPIC_0020237259__p37504268">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="EN-US_TOPIC_0020237259__p17946858">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="EN-US_TOPIC_0020237259__p44409397">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row40391380"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p50476336">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p62051376">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020237259__li28765112151825"><strong id="EN-US_TOPIC_0020237259__b842352706212315">Request filter</strong> parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table37332024155045" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row20772680155045"><th align="left" class="cellrowborder" valign="top" width="14.099999999999998%" id="mcps1.3.2.2.3.2.1.5.1.1"><p id="EN-US_TOPIC_0020237259__p61804813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.34%" id="mcps1.3.2.2.3.2.1.5.1.2"><p id="EN-US_TOPIC_0020237259__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.350000000000001%" id="mcps1.3.2.2.3.2.1.5.1.3"><p id="EN-US_TOPIC_0020237259__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.209999999999994%" id="mcps1.3.2.2.3.2.1.5.1.4"><p id="EN-US_TOPIC_0020237259__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row56787744155045"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p36404558155045">name</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p63088125155045">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p9864533155045">string</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p60829693155045">Name of the backups to be queried. This parameter is used to query the backups whose names are specified character strings.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row10596326155045"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p52996106155045">status</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p64826194155045">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p16430375155045">string</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p55791984155045">Status of the backups to be queried. This parameter is used to query the backups in a specified state. The value can be <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue28614251112"><b>available</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue128626271118"><b>error</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue168626261110"><b>restoring</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue686222151114"><b>creating</b></span>, <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue086242171112"><b>deleting</b></span>, or <span class="parmvalue" id="EN-US_TOPIC_0020237259__parmvalue686320221110"><b>error_restoring</b></span>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row098791912487"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p1098715193486">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p1198841974818">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p186705308494">string</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p119882199481">Sorts by attribute. Possible values are <strong id="EN-US_TOPIC_0020237259__b6825152514612">name</strong>, <strong id="EN-US_TOPIC_0020237259__b103497281868">status</strong>, <strong id="EN-US_TOPIC_0020237259__b145897321769">container_format</strong>, <strong id="EN-US_TOPIC_0020237259__b147751234263">disk_format</strong>, <strong id="EN-US_TOPIC_0020237259__b18773391565">size</strong>, <strong id="EN-US_TOPIC_0020237259__b13396141465">id</strong>, <strong id="EN-US_TOPIC_0020237259__b11185194511619">created_at</strong>, and <strong id="EN-US_TOPIC_0020237259__b46031448663">updated_at</strong>. The default value is <strong id="EN-US_TOPIC_0020237259__b155782582062">created_at</strong>. This API uses the natural sort direction of the <strong id="EN-US_TOPIC_0020237259__b28682579717">sort_key</strong> attribute.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row132476231482"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p653220411497">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p424710236484">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p11193931204919">string</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p324716231485">Sorts by a set of one or more sort direction and attribute (<strong id="EN-US_TOPIC_0020237259__b13143112111459">sort_key</strong>) combinations. If you omit the sort direction in a set, the value defaults to <strong id="EN-US_TOPIC_0020237259__b2237181281216">desc</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row32365812155045"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p4385095155045">offset</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p19648386155045">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p48015438155045">int</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p64045266155045">Offset of the queried information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row39536489155045"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p48339061155045">limit</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p23149902155045">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p63202779155045">int</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p19151493155045">Maximum number of query results that can be returned</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row5614570164116"><td class="cellrowborder" valign="top" width="14.099999999999998%" headers="mcps1.3.2.2.3.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237259__p4498303164118">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.34%" headers="mcps1.3.2.2.3.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237259__p28818245164118">No</p>
</td>
<td class="cellrowborder" valign="top" width="13.350000000000001%" headers="mcps1.3.2.2.3.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237259__p52576545164118">string</p>
</td>
<td class="cellrowborder" valign="top" width="59.209999999999994%" headers="mcps1.3.2.2.3.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237259__p30841720164118">Disk ID of the backups to be queried. It is used to query the backups for specific disks.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020237259__li54108872162316">Example request<pre class="screen" id="EN-US_TOPIC_0020237259__screen28915226101329">GET /v2/{project_id}/backups/detail?name=backup&amp;status=error&amp;limit=10&amp;volume_id=7d7c6fbe-d7ee-4b4d-8bae-bdd08b5604bb</pre>
<p id="EN-US_TOPIC_0020237259__p55191590162318"></p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020237259__section25265097"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020237259__p5960130615189">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020237259__section26059286"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0020237259__ul12614887"><li id="EN-US_TOPIC_0020237259__li42642085202619">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table48234446202619" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row55367383202619"><th align="left" class="cellrowborder" valign="top" width="28.74%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0020237259__p9816113115130">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.39%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0020237259__p148161731141319">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.87%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0020237259__p138168311139">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row5405314117637"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p1622830017637">backups</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p388999251771">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p638861871771">List of queried backups</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row63899507202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p8477569202619">status</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p3812946216349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p55194315202619">Backup status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row26986790202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p38446351202619">description</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p147871316349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p51398114202619">Backup description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row59929844202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p22479234202619">links</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p5266693716349">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p48084179202619">Backup URL</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row30104430202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p22539803202619">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p3816348516349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p42822461202619">AZ where the backup resides</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row49857835202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p11952800202619">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p3926917816420">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p39169096202619">Source disk ID of the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row16977544202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p33003808202619">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p1551126516414">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p44790369202619">Cause of the backup failure</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row460141202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p37271474202619">id</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p6707960416349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p60551425202619">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row8091914202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p51465269202619">size</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p6473887516349">int</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p38938725202619">Backup size</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row14904212202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p66390544202619">object_count</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p935748516349">int</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p51837782202619">Number of objects on Object Storage Service (OBS) for the disk data</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row63886860202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p7453171202619">container</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p1975883616349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p45004514202619">Container of the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row2387448202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p59165588202619">name</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p5696191216349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p27753504202619">Backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row48454951202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p32536945202619">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p5051216016349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1604592202619">Backup creation time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row436163494914"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p148191537181410">os-bak-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p7972235194916">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p12972133513498">ID of the project that owns the VBS backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row14441328202619"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p28896915202619">service_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p6495317316349">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p10122423202619">Backup metadata</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row4023893017450"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p1675189817462">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p5199816317462">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p5110169017462">Time when the backup was updated</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row587809217458"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p51017140174631">data_timestamp</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p51551297174631">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p14905520174631">Current time</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row5551782717455"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p47171598175250">has_dependent_backups</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p53882996175250">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p2446587175250">Whether a dependent backup exists. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row2950474175228"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p38731483175250">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p43102204175250">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1617637175250">ID of the snapshot associated with the backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row46058702175233"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p38407358175250">is_incremental</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p64003470175250">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p16898564175250">Whether the backup is an incremental backup. VBS generates a full backup for the initial backup operation and incremental backups for subsequent backup operations. Therefore, this parameter will be skipped.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row4426806101854"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p1422124714456">backups_links</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p2428687314456">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p2107967814456">Only part of a tenant's backup information is queried, such as query by page with the <strong id="EN-US_TOPIC_0020237259__b12196032117">limit</strong> specified and when the number of backups exceeds 1000.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row554657171454"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p6626476114456">href</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p604027431454">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p607840521454">URL of the last backup queried</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row1549701514553"><td class="cellrowborder" valign="top" width="28.74%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p4729870714553">rel</p>
</td>
<td class="cellrowborder" valign="top" width="18.39%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p1543247614553">string</p>
</td>
<td class="cellrowborder" valign="top" width="52.87%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p4207106614553">Relationship between the query result and <strong id="EN-US_TOPIC_0020237259__b842352706202944">href.</strong> The value <strong id="EN-US_TOPIC_0020237259__b1636101139174441">next</strong> indicates that some backups are not obtained.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020237259__li43731748131417"><strong id="EN-US_TOPIC_0020237259__b163394613214">service_metadata</strong> parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table1037654820140" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row738274810147"><th align="left" class="cellrowborder" valign="top" width="26.090000000000003%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="EN-US_TOPIC_0020237259__p1038584831413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="EN-US_TOPIC_0020237259__p5388174816141">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.43%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="EN-US_TOPIC_0020237259__p0392144819146">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row9394548131410"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p5396184818142">DL</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p15399164817145">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1540134821414"><strong id="EN-US_TOPIC_0020237259__b1883017264192">0</strong>: non-deduplication and non-compression; <strong id="EN-US_TOPIC_0020237259__b142166218198">1</strong>: deduplication and non-compression; <strong id="EN-US_TOPIC_0020237259__b15128132531917">2</strong>: non-deduplication and compression; <strong id="EN-US_TOPIC_0020237259__b14302192919191">3</strong>: deduplication and compression If this key is not specified, the value is 0 (non-deduplication and non-compression).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row94031648131410"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p1040514821415">VK</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p2408448151415">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p7949104222620">Encryption VK of an encrypted volume. The value is a string of 64 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row64111148161411"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p114136486148">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p144151748181415">boolean</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p104187485142">Whether the disk is the boot disk</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row541984861411"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p19420174812149">backupurl</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p1676418182174">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p4424114851411">Backup image ID on the backup system</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row03821658101519"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p13851858181514">SP</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p113852587150">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1158282184118">Path name of the backup image in the storage unit</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row116119111162"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p61614115165">VMID</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p016111119169">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p816218117162">ID of the VM to which the backup image belongs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row179902621610"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p1065015891711">ST</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p89901621617">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p10990661166">Backup service type. <strong id="EN-US_TOPIC_0020237259__b131529101718">0</strong>: disk backup; <strong id="EN-US_TOPIC_0020237259__b712412322176">1</strong>: VM backup; <strong id="EN-US_TOPIC_0020237259__b119811533121716">4</strong>: disk backup copy, <strong id="EN-US_TOPIC_0020237259__b19271836151710">5</strong>: VM backup copy. If this tag does not exist, disk backup is specified.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row1990763169"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p8990566167">BT</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p49901666161">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1899017601613">Backup storage type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row137111118161"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p13791120169">SS</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p537611141610">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p93711113169">Space saving rate</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row737911191619"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p937121151618">BP</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p43771117167">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p74481998308">Storage unit path</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row23761171615"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p203711161610">CMKID</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p037101113163">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p937101121615">Specifies the CMK ID of an encrypted volume. The content is UUID and contains 36 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row33731112164"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p113741119161">progress</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p133713114166">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p11371118164">Backup progress</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row19786843181812"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p6786154341819">CS</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p17786143141812">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1578624314182">Total backup data of the chain where the backup is located. The unit is MB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row117869430183"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p578684314188">VT</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p197869431189">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1878618438185">Production storage disk type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row178694318186"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p197861443131814">OMID</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p37861143191816">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p5786124315184">Host ID of the job execution node</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row1578634301813"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p127861243151811">Type</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p10786194320185">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p12786164315186">Backup type. <strong id="EN-US_TOPIC_0020237259__b15716111274919">0</strong>: full backup; <strong id="EN-US_TOPIC_0020237259__b15725912114916">1</strong>: incremental backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row6786743181818"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p27877438187">ebk_T_I</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p19787164310183">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p1019923311356">Job ID of the backup system</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row57871543201820"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p27878437188">AT</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p1478718431186">float</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p378794361812">Average rate (Average Throughput). The unit is MB/s. One digit is reserved after the decimal point.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020237259__li3925161313353"><strong id="EN-US_TOPIC_0020237259__b163851483142">description</strong> parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table10930121323510" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row59421013153511"><th align="left" class="cellrowborder" valign="top" width="26.090000000000003%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="EN-US_TOPIC_0020237259__p9947413163511">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.48%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="EN-US_TOPIC_0020237259__p495361316355">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.43%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="EN-US_TOPIC_0020237259__p29555136354">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row59596134354"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p115025378354">DESC</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p8502133733515">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p7501163716354">Backup description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row16500123383518"><td class="cellrowborder" valign="top" width="26.090000000000003%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="EN-US_TOPIC_0020237259__p174991237103512">INC</p>
</td>
<td class="cellrowborder" valign="top" width="18.48%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="EN-US_TOPIC_0020237259__p949823716356">int</p>
</td>
<td class="cellrowborder" valign="top" width="55.43%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="EN-US_TOPIC_0020237259__p149653783520">Whether the backup request was an incremental backup call. <strong id="EN-US_TOPIC_0020237259__b22041344141714">1</strong>: incremental backup; <strong id="EN-US_TOPIC_0020237259__b381849141718">0</strong>: full backup</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020237259__li46425119">Example response<pre class="screen" id="EN-US_TOPIC_0020237259__screen16320388101345">{
"backups": [
{
"status": "error",
"description": null,
"links": [
{
"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
"rel": "self"
},
{
"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/1d1139d8-8989-49d3-8aa1-83eb691e6db2",
"rel": "bookmark"
}
],
"availability_zone": null,
"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
"id": "1d1139d8-8989-49d3-8aa1-83eb691e6db2",
"size": 1,
"object_count": null,
"container": "volumebackups",
"name": null,
"created_at": "2013-06-27T08:48:03.000000",
"os-bak-tenant-attr:tenant_id": "b23b579f08c84228b9b4673c46f0c442",
"service_metadata": " {\"bootable\": false, \"backupurl\": \"58d94782-6509-45ad-9442-970d2a005050\", \"BackupSize\": 0, \"progress\": \"0\", \"snap_id\": \"665e411f5d87431ca98c199fbd4a64fd\", \"Type\": 0} "
},
{
"status": "error",
"description": null,
"links": [
{
"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
"rel": "self"
},
{
"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/80e17946-6e56-46e0-9547-e9ba4f1619bd",
"rel": "bookmark"
}
],
"availability_zone": null,
"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
"id": "80e17946-6e56-46e0-9547-e9ba4f1619bd",
"size": 1,
"object_count": null,
"container": "volumebackups",
"name": null,
"created_at": "2013-06-27T08:56:58.000000"
},
{
"status": "error",
"description": null,
"links": [
{
"href": "http://192.168.82.222:8776/v2/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
"rel": "self"
},
{
"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups/b3cf7a16-decc-4beb-8077-682737d94a58",
"rel": "bookmark"
}
],
"availability_zone": null,
"volume_id": "2748f2f2-4394-4e6e-af8d-8dd34496c024",
"fail_reason": "Connection to swift failed: [Errno 111] ECONNREFUSED",
"id": "b3cf7a16-decc-4beb-8077-682737d94a58",
"size": 1,
"object_count": null,
"container": "volumebackups",
"name": null,
"created_at": "2013-06-27T08:46:31.000000"
}
],
"backups_links": [
{
"href": "http://192.168.82.222:8776/b23b579f08c84228b9b4673c46f0c442/backups?limit=1&amp;offset=1&amp;marker=b3cf7a16-decc-4beb-8077-682737d94a58",
"rel": "next"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020237259__section33206990"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0020237259__ul42565233"><li id="EN-US_TOPIC_0020237259__li47542785">Normal<p id="EN-US_TOPIC_0020237259__p25231885"><a name="EN-US_TOPIC_0020237259__li47542785"></a><a name="li47542785"></a>200</p>
</li><li id="EN-US_TOPIC_0020237259__li25760373">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237259__table24890860203310" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237259__row29188547203310"><th align="left" class="cellrowborder" valign="top" width="43.419999999999995%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0020237259__p15462140203310">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0020237259__p44473833203310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020237259__row45610739203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p3482369203310">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p13636476203310">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row55619421203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p8879270203310">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p48132239203310">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row30536967203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p57575235203310">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p33082484203310">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row29306908203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p25049367203310">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p15732859203310">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row7378003203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p60747366203310">405 Method Not Allowed</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p21589622203310">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row60088872203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p35360445203310">406 Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p45623811203310">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row7961120203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p40870961203310">407 Proxy Authentication Required</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p22213576203310">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row65704456203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p20460704203310">408 Request Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p46704304203310">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row17685557203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p23244013203310">409 Conflict</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p3716914203310">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row33452228203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p25275975203310">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p34088074203310">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row38357211203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p19926369203310">501 Not Implemented</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p3423229203310">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row30809061203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p12506042203310">502 Bad Gateway</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p6356504203310">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row57208537203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p3379926203310">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p5338608203310">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020237259__row48047475203310"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237259__p66640258203310">504 Gateway Timeout</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020237259__p29151842203310">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020237259__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020237259__p129821455154315">For details, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0020237254.html">VBS Backups</a></div>
</div>
</div>
View Git Blame Copy Permalink