doc-exports/docs/csbs/api-ref/en-us_topic_0059304234.html
Wei, Hongmin 8ce662c4dc CSBS 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-24 21:06:50 +00:00

732 lines
54 KiB
HTML

<a name="EN-US_TOPIC_0059304234"></a><a name="EN-US_TOPIC_0059304234"></a>
<h1 class="topictitle1">Querying a Single Backup</h1>
<div id="body14689446"><div class="section" id="EN-US_TOPIC_0059304234__section37966355"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0059304234__p48994505">This API is used to query a single backup by ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304234__section6152882"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304234__ul9131948"><li id="EN-US_TOPIC_0059304234__li15078669">URI format<p id="EN-US_TOPIC_0059304234__p1490295"><a name="EN-US_TOPIC_0059304234__li15078669"></a><a name="li15078669"></a>GET https://{endpoint}/v1/{project_id}/checkpoint_items/{checkpoint_item_id}</p>
</li><li id="EN-US_TOPIC_0059304234__li13412659">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table53605075" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row53075243"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0059304234__p45356064">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0059304234__p49962569">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0059304234__p20436323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0059304234__p44729494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row49612778"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304234__p59212070">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304234__p31448326">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304234__p64286450">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304234__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row22835571"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304234__p37741982">checkpoint_item_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304234__p37201714">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304234__p60548821">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304234__p5507506">Backup ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304234__section55375943"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304234__ul43454831"><li id="EN-US_TOPIC_0059304234__li55549161">Parameter description<p class="msonormal" id="EN-US_TOPIC_0059304234__p16784255144610"><a name="EN-US_TOPIC_0059304234__li55549161"></a><a name="li55549161"></a>None</p>
</li></ul>
<ul id="EN-US_TOPIC_0059304234__ul3188186"><li id="EN-US_TOPIC_0059304234__li28693674">Example request<pre class="screen" id="EN-US_TOPIC_0059304234__screen3354489214">GET https://{endpoint}/v1/{project_id}/checkpoint_items/{checkpoint_item_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304234__section28621443"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304234__ul46832064"><li id="EN-US_TOPIC_0059304234__li18835399">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table35300871" width="90%" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row22790824"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p108841358145215">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p98991958185213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p14899458165215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row20070764"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p15119192">checkpoint_item</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p10120705">checkpoint_item</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p14470799">For details, see <a href="#EN-US_TOPIC_0059304234__table31284045">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li63128328">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b42045429">checkpoint_item</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304234__table31284045"></a><a name="table31284045"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table31284045" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304234__b1764273513711">checkpoint_item</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row64126600"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p358732175317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p17602112135318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p3602102165316">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row26325568"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p51996302">checkpoint_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p33385823">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p19897138">Backup record ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row44856519"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p9499412">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p48618095">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p45751629">Creation time, for example, <strong id="EN-US_TOPIC_0059304234__b344382912146">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row9111485"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p66941716">extend_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p44192877">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p22853313">Extension information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row4353229"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p17067270">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p40779379">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p14795382">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row66049575"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p48415341">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p26805152">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p23733724">Backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row12276932"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p54907410">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p7135583">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p41111342">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row34457765"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p39615556">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p5034912">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p5174700">Backup status</p>
<p id="EN-US_TOPIC_0059304234__p199923219255">Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row16497581"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p61235723">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p53922812">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p5671647">Modification time, for example, <strong id="EN-US_TOPIC_0059304234__b3787930121412">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row51044828"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p40990393">backup_data</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p32752180">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p35680930">VM metadata</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row7523923353"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p2052319231152">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p25231123550">string</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p1452312318520">Backup description</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row1483112381346"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p583173853411">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p12831193833415">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p448733435210">List of backup tags</p>
<p id="EN-US_TOPIC_0059304234__p7831173883410">Keys in the tag list must be unique.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row186965413101"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p1430747161018">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p133205712103">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p83271175104">Backup object type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li52692922">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b56174843">extend_info</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table4474257" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304234__b111607">extend_info</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row25374974"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p3337529105312">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p0352142925311">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p8368429165320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row35881396"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p20711946">auto_trigger</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p62743133">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p49029033">Whether automatic trigger is enabled</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row38608121"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p40250071">average_speed</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p7336516">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p57386915">Average rate. The unit is kb/s</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row46720194"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p26239345">copy_from</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p22108653">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p45970441">The destination region of a backup replication. The value is left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row11080792"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p5700168">copy_status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p19168703">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p112911849103111">Backup replication status. The default value is <strong id="EN-US_TOPIC_0059304234__b75876111958">na</strong>.</p>
<p id="EN-US_TOPIC_0059304234__p173113381512">Possible values are <strong id="EN-US_TOPIC_0059304234__b17503147113010">na</strong>, <strong id="EN-US_TOPIC_0059304234__b18503174783014">waiting_copy</strong>, <strong id="EN-US_TOPIC_0059304234__b17504114716304">copying</strong>, <strong id="EN-US_TOPIC_0059304234__b15504184783012">success</strong>, and <strong id="EN-US_TOPIC_0059304234__b850564713304">fail</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row40063217"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p23895134">fail_code</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p9669625">fail_code</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p45042167">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row2726327"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p19505966">fail_op</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p2039495">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p30981435">Type of the failed operation</p>
<p id="EN-US_TOPIC_0059304234__p10397463">Enum: [backup, restore, delete]</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row26468307"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p63558136">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p57560327">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p31874881">Description of the failure cause</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row18438475"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p17121511">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p61107184">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p50734894">Backup type, for example, <strong id="EN-US_TOPIC_0059304234__b916517281253">backup</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row53960863"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p8753788">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p55529076">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p1561311">Whether the backup is an enhanced backup</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row14051800"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p64454033">progress</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p29959179">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p10774429">Backup progress. The value is an integer ranging from <strong id="EN-US_TOPIC_0059304234__b19691513313">0</strong> to <strong id="EN-US_TOPIC_0059304234__b5350121733313">100</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row29860999"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p2821893">resource_az</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p59506486">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p55296057">AZ to which the backup resource belongs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row27902470"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p45507587">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p7944126">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p39494476">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row611222610436"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p149812204222">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p998142020221">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p09822022216">Type of the backup object. For example, <strong id="EN-US_TOPIC_0059304234__b169851814616">OS::Nova::Server</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row19905972"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p1771067">size</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p10137332">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p15817592">Backup capacity. The unit is MB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row8140604"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p55409189">space_saving_ratio</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p10978802">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p16867749">Space saving rate</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row17592014"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p15667012">volume_backups</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p47601111">List&lt;volume_backup&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p30484803">Disk backup list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row5927779"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p10388065">finished_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p40598030">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p106125">Backup completion time, for example, <strong id="EN-US_TOPIC_0059304234__b866388191513">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row1878614674719"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p14691120181216">supported_restore_mode</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p204691920121214">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p18728201715">Restoration mode. Possible values are <strong id="EN-US_TOPIC_0059304234__b46774915241">na</strong>, <strong id="EN-US_TOPIC_0059304234__b8823182419241">snapshot</strong>, and <strong id="EN-US_TOPIC_0059304234__b667817919244">backup</strong>.</p>
<p id="EN-US_TOPIC_0059304234__p8166816173"><strong id="EN-US_TOPIC_0059304234__b84235270610831">backup</strong>: Data is restored from backups of the disks of the server.</p>
<p id="EN-US_TOPIC_0059304234__p11211554424"><strong id="EN-US_TOPIC_0059304234__b84235270610912">na</strong>: Restoration is not supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row227118084815"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p76063254014">os_images_data</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p860103213408">List&lt;image_data&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p18603325403">Image data. This parameter has a value if an image has been created for the VM.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row14392013145013"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p19986193041010">support_lld</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p898783012102">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p14987330181013">Whether to allow lazyloading for fast restoration</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row8909163111020"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p189025313106">taskid</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p11902123114103">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p690212311100">Job ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row59081931161020"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p990283111013">hypervisor_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p11902163113108">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p17903133181016">Virtualization type</p>
<p id="EN-US_TOPIC_0059304234__p78814320472">The value is fixed at <strong id="EN-US_TOPIC_0059304234__b132411816133111">QEMU</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li955132">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b179657794417188">backup_data</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table8596189" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304234__b17321959">backup_data</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row56714947"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p8227122710547">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p152422278549">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p6242152712542">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row63047142"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p6544886">__openstack_region_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p58434603">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p35582368">Name of the AZ where the server is located. If this parameter is left blank, such information about the server has not been obtained.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row51805857"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p35524928">cloudservicetype</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p9973792">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p2570800">Server type</p>
<p id="EN-US_TOPIC_0059304234__p16315123095611">The value is fixed at <strong id="EN-US_TOPIC_0059304234__b15296113993514">server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row23137205"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p62174317">disk</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p38022763">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p59944961">System disk size corresponding to the server specifications</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row2633738"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p12006197">imagetype</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p53964645">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p34827724172525">Image type</p>
<p id="EN-US_TOPIC_0059304234__p53936227172521">The value can be:</p>
<p id="EN-US_TOPIC_0059304234__p58292001172520"><strong id="EN-US_TOPIC_0059304234__b406533172520">gold</strong>: public image</p>
<p id="EN-US_TOPIC_0059304234__p19620176172519"><strong id="EN-US_TOPIC_0059304234__b60702406172519">private</strong>: private image</p>
<p id="EN-US_TOPIC_0059304234__p8318888165816"><strong id="EN-US_TOPIC_0059304234__b316142575171853">market</strong>: market image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row62783896"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p52330790">ram</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p47221276438">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p8862978">Memory size of the server, in MB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row12657945"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p18660600">vcpus</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p27451615134318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p62839584">CPU cores corresponding to the server</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row28685351"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p41812081">eip</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p55141104">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p37244403">Elastic IP address of the server. If this parameter is left blank, such information about the server has not been obtained.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row66764179"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p39189427">private_ip</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p27774216">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p35118989">Internal IP address of the server. If this parameter is left blank, such information about the server has not been obtained.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li3659722185710">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b1668711185814">image_data</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table17665422205719" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304234__row156851122175719"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.5.2.1.4.1.1"><p id="EN-US_TOPIC_0059304234__p4940215576">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.5.2.1.4.1.2"><p id="EN-US_TOPIC_0059304234__p149462145712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.5.2.1.4.1.3"><p id="EN-US_TOPIC_0059304234__p811019214572">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row6718112212576"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="EN-US_TOPIC_0059304234__p11724172211573">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="EN-US_TOPIC_0059304234__p173310227573">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="EN-US_TOPIC_0059304234__p3739112205719">Image ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li19596328917">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b1724520371511">fail_code</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table13384103111117" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304234__b1805339070">fail_code</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row173845314115"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.6.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p25471729115712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.6.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p656332925713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.6.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p11563129145715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row1838415319115"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p14384103120115">Code</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p13384113115116">Long</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p23846311716">Error code</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row20384231212"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p838433113119">Description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p23849318116">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p163844311713">Error description</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li47635446">Parameter description of field<strong id="EN-US_TOPIC_0059304234__b3155873"> volume_backup</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table26065838" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field<strong id="EN-US_TOPIC_0059304234__b2175687"> volume_backup</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row3231685"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.4.2.7.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p18379154413571">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.28%" id="mcps1.3.4.2.7.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p6395104425713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.4.2.7.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p183957444571">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row8986735"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p56836906">average_speed</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p50095482">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p31202271">Average rate, in MB/s</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row12384989"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p63660086">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p55367277">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p55564443">Whether the disk functions as a system disk</p>
<p id="EN-US_TOPIC_0059304234__p16852144118620">The value can be <strong id="EN-US_TOPIC_0059304234__b1378425815460">true</strong> or <strong id="EN-US_TOPIC_0059304234__b3785135820461">false</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row30317943"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p39834343">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p31212633">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p45195306">Cinder backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row4104573"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p64035022">image_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p32297070">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p65925901">Backup set type</p>
<p id="EN-US_TOPIC_0059304234__p56462200">Enum:[ backup]</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row38397760"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p23210864">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p16467941">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p58834810">Whether incremental backup is used</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row59751243"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p8012554">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p24132138">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p8546138">Disk backup name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row9806383"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p56119559">size</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p41203013">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p49109755">Accumulated size (MB) of backups</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row39334612"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p31986975">source_volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p17128847">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p45259396">Source disk ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row4681386"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p43648019">source_volume_size</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p21133674">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p34106024">Source disk size in GB</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row38518764"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p33012204">space_saving_ratio</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p32770942">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p37200607">Space saving rate</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row66370010"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p7261755">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p64196347">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p32521642">Status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row24259325"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p18848346">source_volume_name</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p49472988">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p47889106">Source disk name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row0397855134916"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p18739530979">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p773917301975">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p3739143011716">ID of the snapshot from which the backup is generated</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li62260646">Parameter description of field <strong id="EN-US_TOPIC_0059304234__b84235270695528">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table1431115645119" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304234__b79005429380">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304234__row4339106155119"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.8.2.2.4.1.1"><p id="EN-US_TOPIC_0059304234__p342655335719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.8.2.2.4.1.2"><p id="EN-US_TOPIC_0059304234__p34261953135718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.8.2.2.4.1.3"><p id="EN-US_TOPIC_0059304234__p5442253135717">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row63768665110"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p10380567512">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p1739414617517">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0059304234__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304234__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304234__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row1116111556513"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304234__p1816118554511">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304234__p1116145519518">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304234__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0059304234__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304234__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304234__p5975131663719">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li28348775">Example response<pre class="screen" id="EN-US_TOPIC_0059304234__screen6830163811213">{
"checkpoint_item": {
"status": "available",
"backup_data": {
"eip": "",
"cloudservicetype": "",
"ram": 4096,
"vcpus": 4,
"__openstack_region_name": "",
"private_ip": "",
"disk": 0,
"imagetype": ""
},
"name": "backup_d32c",
"resource_id": "f45c477a-57e5-465f-999f-d845083962db",
"created_at": "2017-04-15T04:20:37.277880",
"checkpoint_id": "f672a1bb-6912-446a-816c-72792c5263e0",
"updated_at": "2017-04-15T04:25:38.680638",
"resource_type": "OS::Nova::Server",
"extend_info": {
"auto_trigger": false,
"space_saving_ratio": 0,
"copy_status": "na",
"fail_reason": "",
"resource_az": "az1.dc1",
"image_type": "backup",
"finished_at": "2017-04-15T04:25:38.675478",
"average_speed": 0,
"copy_from": "",
"supported_restore_mode": "backup",
"support_lld": false,
"os_images_data": [
{
"image_id": "fe84dd80-0229-4918-8d3d-cbb33154b565"
}
],
"volume_backups": [
{
"status": "available",
"space_saving_ratio": 0,
"name": "manualbk_47222",
"bootable": true,
"average_speed": 0,
"source_volume_size": 20,
"source_volume_id": "ee27f809-6fb5-40ae-ac46-c932bb4ee8fe",
"incremental": false,
"image_type": "backup",
"source_volume_name": "karbor_02",
"id": "70675cbc-d3a8-43a7-9f81-c8b6bc3f5d6d",
"size": 0,
"snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
},
{
"status": "available",
"space_saving_ratio": 0,
"name": "manualbk_47222",
"bootable": true,
"average_speed": 0,
"source_volume_size": 20,
"source_volume_id": "e7f48980-927c-48de-afd4-f0245d2e5100",
"incremental": false,
"image_type": "backup",
"source_volume_name": "karbor_01",
"id": "8eb98e91-8924-4d4b-b6d6-28fb7b751e9c",
"size": 0,
"snapshot_id": "36f520e1-d2ea-4907-956a-3d9cd53e2d38"
}
],
"fail_code": {},
"incremental": false,
"taskid": "e0a21692-2192-11e7-bf23-0242ac110007",
"hypervisor_type": "QEMU",
"progress": 100,
"fail_op": "",
"resource_name": "karbor_02",
"size": 0
},
"id": "90c1d5fa-1b9f-4aeb-b2f4-81c806e98190"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304234__section56266399"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304234__ul62508084"><li id="EN-US_TOPIC_0059304234__li25701845">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table29990020" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304234__row12023846"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304234__p34407455">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304234__p35540469">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row60205711"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p44824405">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p6898225">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304234__li62084025">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304234__table21885320" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304234__row58019898"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304234__p1991264">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304234__p27074695">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304234__row45566678"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p67022326">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p60099343">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row4023176"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p57441800">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p22274196">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row66250043"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p64653253">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p2422160">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row21799445"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p20924644">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p17174599">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304234__row20353668"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304234__p38034401">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304234__p60887622">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304234__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304234__p999593594811">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0059304229.html">Backup Management</a></div>
</div>
</div>