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_0143705539.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

209 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0143705539"></a><a name="EN-US_TOPIC_0143705539"></a>
<h1 class="topictitle1">Restoring a Disk Using a VBS Backup (Native OpenStack V3 API)</h1>
<div id="body1543923017092"><div class="section" id="EN-US_TOPIC_0143705539__section11854613"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0143705539__p22646572">This API is used to restore a disk using a VBS backup.</p>
</div>
<div class="section" id="EN-US_TOPIC_0143705539__section39582655"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0143705539__ul22433040"><li id="EN-US_TOPIC_0143705539__li570775">URI format<p id="EN-US_TOPIC_0143705539__p38994554479"><a name="EN-US_TOPIC_0143705539__li570775"></a><a name="li570775"></a>POST /v3/{project_id}/backups/{backup_id}/restore</p>
</li><li id="EN-US_TOPIC_0143705539__li13442339">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0143705539__table53872188" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0143705539__row40420929"><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_0143705539__p52869820">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_0143705539__p54597003">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_0143705539__p60281111">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0143705539__row50931783"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0143705539__p31833731">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_0143705539__p28395444">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_0143705539__p64170449">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row30749271"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0143705539__p7663035">backup_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_0143705539__p16726062">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_0143705539__p12633819">ID of the backup used to restore a disk</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0143705539__section20699582"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0143705539__ul1787872614263"><li id="EN-US_TOPIC_0143705539__li8878162613260">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0143705539__table1687812615267" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0143705539__row2087872611268"><th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0143705539__p61804813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.13%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0143705539__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0143705539__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0143705539__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0143705539__row570766171331"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0143705539__p46232095171331">restore</p>
</td>
<td class="cellrowborder" valign="top" width="13.13%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0143705539__p53812216171331">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0143705539__p63822274171331">dict</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0143705539__p2221733171331">Information about the disk to be restored</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row1087972612265"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0143705539__p587932612615">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.13%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0143705539__p28792262264">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.14%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0143705539__p17879326202615">string</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0143705539__p18791262269">ID of the disk to be restored</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0143705539__ul12880182617268"><li id="EN-US_TOPIC_0143705539__li1388002611264">Example request<pre class="screen" id="EN-US_TOPIC_0143705539__screen16880192619262">{
"restore": {
"volume_id":<em id="EN-US_TOPIC_0143705539__i52420363171736"> "2748f2f2-4394-4e6e-af8d-8dd34496c024"</em>
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0143705539__section52078514"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0143705539__ul11041789"><li id="EN-US_TOPIC_0143705539__li57872974202521">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0143705539__table46024180171524" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0143705539__row56596790171524"><th align="left" class="cellrowborder" valign="top" width="23.53%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0143705539__p16959711142017">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0143705539__p12959111102013">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.120000000000005%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0143705539__p5959101112208">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0143705539__row25919714171524"><td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0143705539__p19122053171524">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0143705539__p1383663416487">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0143705539__p15309284171524">Backup ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row3565834171524"><td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0143705539__p20397103171524">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0143705539__p0602173694819">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0143705539__p30566249171524">Disk ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row6660791171524"><td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0143705539__p2653175171524">volume_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0143705539__p13580632171524">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.120000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0143705539__p49067419171524">Disk name</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0143705539__li32267243">Example response<pre class="screen" id="EN-US_TOPIC_0143705539__screen65555681171654">{
"restore": {
"backup_id": "<em id="EN-US_TOPIC_0143705539__i21619054171748">1d1139d8-8989-49d3-8aa1-83eb691e6db2</em>",
"volume_id": "<em id="EN-US_TOPIC_0143705539__i12531408171835">2748f2f2-4394-4e6e-af8d-8dd34496c024</em>"
"volume_name": "test_volume"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0143705539__section66053444"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0143705539__ul43299552"><li id="EN-US_TOPIC_0143705539__li54151655">Normal<p id="EN-US_TOPIC_0143705539__p17602849"><a name="EN-US_TOPIC_0143705539__li54151655"></a><a name="li54151655"></a>202</p>
</li><li id="EN-US_TOPIC_0143705539__li24207921">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0143705539__table17411442203238" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0143705539__row20469972203238"><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_0143705539__p47455040203238">Status Codes</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_0143705539__p18653028203238">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0143705539__row34500329203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p43063287203238">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_0143705539__p65574197203238">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row53296861203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p22078503203238">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_0143705539__p43528309203238">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row56210465203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p56753841203238">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_0143705539__p33658426203238">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row34490379203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p42257275203238">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_0143705539__p287223203238">The server could not find the requested page or resources.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row2585014203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p8059568203238">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_0143705539__p48845291203238">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row36954440203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p40519687203238">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_0143705539__p60869210203238">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row10951983203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p14695420203238">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_0143705539__p49478353203238">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row42651999203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p32259860203238">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_0143705539__p62911845203238">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row29335700203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p27381532203238">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_0143705539__p3311604203238">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row29804437203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p65349225203238">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_0143705539__p58795873203238">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row59400814203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p46736664203238">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_0143705539__p27573467203238">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row46834613203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p35507279203238">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_0143705539__p57517333203238">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row47893957203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p54205305203238">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_0143705539__p28553614203238">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0143705539__row55655940203238"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0143705539__p11837325203238">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_0143705539__p19299274203238">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0143705539__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0143705539__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