forked from docs/doc-exports
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com> Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
310 lines
25 KiB
HTML
310 lines
25 KiB
HTML
<a name="EN-US_TOPIC_0020237255"></a><a name="EN-US_TOPIC_0020237255"></a>
|
|
|
|
<h1 class="topictitle1">Creating a VBS Backup</h1>
|
|
<div id="body38398082"><div class="section" id="EN-US_TOPIC_0020237255__section63962185"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020237255__p23236933">This API is used to create a VBS backup.</p>
|
|
<p id="EN-US_TOPIC_0020237255__p358532371211">If the API is successfully called, the backup task is successfully delivered. You can query the backup status by using the API for <a href="en-us_topic_0020237260.html">Querying Details About a VBS Backup (Native OpenStack API)</a>.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020237255__section38788755"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0020237255__ul3143429"><li id="EN-US_TOPIC_0020237255__li28290863">URI format<p id="EN-US_TOPIC_0020237255__p9858548"><a name="EN-US_TOPIC_0020237255__li28290863"></a><a name="li28290863"></a>POST /v2/{project_id}/cloudbackups</p>
|
|
</li><li id="EN-US_TOPIC_0020237255__li21618074">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table60344938" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row59011071"><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_0020237255__p15167431">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_0020237255__p20602375">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_0020237255__p58179688">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row14934289"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237255__p1717931">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_0020237255__p4934750">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_0020237255__p64170449">Project ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020237255__section13554483"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0020237255__ul30423852"><li id="EN-US_TOPIC_0020237255__li5379216">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table48412952" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row28932175"><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_0020237255__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_0020237255__p40133923">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.83%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0020237255__p14225104112">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.88999999999999%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0020237255__p29622330">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row187031441791"><td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p385596811791">backup</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_0020237255__p363264551791">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.83%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p567617131791">dict</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.88999999999999%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p342960231791">Backup to be created. For details, see the <strong id="EN-US_TOPIC_0020237255__b2167716175313">backup</strong> field description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0020237255__li862417528195"><strong id="EN-US_TOPIC_0020237255__b731258105911">backup</strong> field description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table1864132719178" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row064112751715"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="EN-US_TOPIC_0020237255__p186452718171">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="EN-US_TOPIC_0020237255__p36416279175">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="EN-US_TOPIC_0020237255__p1664182720171">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="EN-US_TOPIC_0020237255__p12641427181712">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row364182741711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p13641327201716">volume_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p864102791710">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p56410276174">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p166412273173">ID of the disk to be backed up</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row156492761714"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p464192711171">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p464927201718">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p146422710172">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p19659276174">Snapshot ID of the disk to be backed up</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row1365112718173"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p17654276175">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p11651327121713">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p196512275174">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p1651427111710">Backup name. The value is a string of 1 to 64 characters that can contain digits, letters, underscores (_), and hyphens (-), not starting with <strong id="EN-US_TOPIC_0020237255__b05913432120">auto</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row19651927121715"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p106552710177">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p665152718171">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p56519275179">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p2659277173">Backup description. The value is a string of 1 to 64 characters and cannot contain the less-than sign (<) or greater-than sign (>).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row12651727171714"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p126512721714">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p865172715178">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p1465427191714">list<dict></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p12651927111710">List of tags to be configured for the backup resources. For details, see the <strong id="EN-US_TOPIC_0020237255__b054110261608">tag</strong> field description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row76522791711"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p156516277178">extend_param</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p665192710176">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p165027181718">map<string,string></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p206582713177">Additional information for creating the VBS backup. The <strong id="EN-US_TOPIC_0020237255__b84235270620309">FullBackup</strong> field is supported. If <strong id="EN-US_TOPIC_0020237255__b1251862158203035">FullBackup</strong> is set to <strong id="EN-US_TOPIC_0020237255__b842352706203125">true</strong>, full backup will be adopted this time. If <strong id="EN-US_TOPIC_0020237255__b1030062150203055">FullBackup</strong> is set to <strong id="EN-US_TOPIC_0020237255__b842352706203121">false</strong> or the parameter is left blank, incremental backup will be adopted.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0020237255__ul582911819211"><li id="EN-US_TOPIC_0020237255__li153165211214"><strong id="EN-US_TOPIC_0020237255__b84235270695528">tag</strong> field description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table2316162182113" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row3316122118215"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.3.1.2.1.5.1.1"><p id="EN-US_TOPIC_0020237255__p631702117212">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.3.2.2.3.1.2.1.5.1.2"><p id="EN-US_TOPIC_0020237255__p143171921192110">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.2.3.1.2.1.5.1.3"><p id="EN-US_TOPIC_0020237255__p133171321172114">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.00000000000001%" id="mcps1.3.3.2.2.3.1.2.1.5.1.4"><p id="EN-US_TOPIC_0020237255__p43174219217">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row5317162119217"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p12317162118211">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p33172212219">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p1331711212217">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p431772116215">Tag key. A tag key consists of up to 36 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row03179218217"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.1 "><p id="EN-US_TOPIC_0020237255__p13179214211">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.2 "><p id="EN-US_TOPIC_0020237255__p103171121102120">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.3 "><p id="EN-US_TOPIC_0020237255__p73171121132118">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.00000000000001%" headers="mcps1.3.3.2.2.3.1.2.1.5.1.4 "><p id="EN-US_TOPIC_0020237255__p2317921172119">Tag value. A tag value consists of 0 to 43 characters. A tag key cannot contain non-printable ASCII characters (0-31) and the following special characters: =*<>\,|/</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<div class="note" id="EN-US_TOPIC_0020237255__note2577104455714"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0020237255__p205772447574">When you use Instant Restore for the first time and the to-be-restored disk has been backed up before the feature is enabled, you need to perform a full backup on the disk on the console or directly call the API for creating a full backup (<strong id="EN-US_TOPIC_0020237255__b842352706184822">POST /v2/{tenant_id}/cloudbackups</strong>). After doing this, the disk backups generated through APIs will support this feature.</p>
|
|
</div></div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0020237255__ul22483156"><li id="EN-US_TOPIC_0020237255__li1021814">Example request<div class="p" id="EN-US_TOPIC_0020237255__p1742415177393"><a name="EN-US_TOPIC_0020237255__li1021814"></a><a name="li1021814"></a><pre class="screen" id="EN-US_TOPIC_0020237255__screen511018169397">{
|
|
"backup": {
|
|
"volume_id":<em id="EN-US_TOPIC_0020237255__i411011610392"> "c68ae7fb-0aa5-4a97-ab01-ed02c5b7e768"</em>,
|
|
"snapshot_id":<em id="EN-US_TOPIC_0020237255__i181101816173920"> null</em>,
|
|
"name":<em id="EN-US_TOPIC_0020237255__i1011011619397"> "backup1"</em>,
|
|
"description":<em id="EN-US_TOPIC_0020237255__i155053112457"> "Backup_Demo"</em>,
|
|
"tags":[{
|
|
"key":"<em id="EN-US_TOPIC_0020237255__i151101216123911">key</em>",
|
|
"value":"<em id="EN-US_TOPIC_0020237255__i1311081612398">value</em>"
|
|
}],
|
|
"extend_param": {"FullBackup": "true"}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020237255__section54881489"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0020237255__ul20896204"><li id="EN-US_TOPIC_0020237255__li2520711120254">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table2553741120254" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row84520220254"><th align="left" class="cellrowborder" valign="top" width="15.428457154284573%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0020237255__p1352611598468">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.088391160883912%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0020237255__p85261859124613">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.48315168483151%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0020237255__p10526959124618">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row894248020254"><td class="cellrowborder" valign="top" width="15.428457154284573%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237255__p5325228320254">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.088391160883912%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237255__p4563373217131">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.48315168483151%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237255__p1948402220254">Job ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row4113847020254"><td class="cellrowborder" valign="top" width="15.428457154284573%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237255__p4388173520254">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.088391160883912%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237255__p534483917131">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.48315168483151%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237255__p1103955520254">Error message returned after an error occurs</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row3224713720254"><td class="cellrowborder" valign="top" width="15.428457154284573%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020237255__p6188131520254">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.088391160883912%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020237255__p3027879417131">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.48315168483151%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020237255__p6179451720254">Error code returned after an error occurs</p>
|
|
<p id="EN-US_TOPIC_0020237255__p1927974620254">For details about error codes, see <a href="en-us_topic_0022472083.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0020237255__li53848109">Example response<pre class="screen" id="EN-US_TOPIC_0020237255__screen59065789101145">{
|
|
"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
|
|
}</pre>
|
|
<p id="EN-US_TOPIC_0020237255__p36388601">or</p>
|
|
<pre class="screen" id="EN-US_TOPIC_0020237255__screen20692691101149">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020237255__section24171358"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0020237255__ul59834015"><li id="EN-US_TOPIC_0020237255__li1635228">Normal<p id="EN-US_TOPIC_0020237255__p14717055"><a name="EN-US_TOPIC_0020237255__li1635228"></a><a name="li1635228"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0020237255__li65344633">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020237255__table51230787" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020237255__row60503138"><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_0020237255__p1807185">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_0020237255__p12164329">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0020237255__row45786577"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p17725233">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_0020237255__p26457778">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row36793414"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p27476571">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_0020237255__p11009764">You must enter the username and password to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row31979016"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p40163483">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_0020237255__p32016662">You are forbidden to access the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row4499052116376"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p2035357816376">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_0020237255__p3802708716376">The server could not find the requested page.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row8462523163725"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p14375766163725">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_0020237255__p23586373163725">You are not allowed to use the method specified in the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row60343628163758"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p55995701163758">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_0020237255__p39357967163758">The response generated by the server could not be accepted by the client.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row32079544163754"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p48306260163754">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_0020237255__p20492948163754">You must use the proxy server for authentication so that the request can be processed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row28680770163738"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p41441040163738">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_0020237255__p1281119163738">The request timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row65552906164354"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p8185203164354">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_0020237255__p59021712164354">The request could not be processed due to a conflict.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row19714506"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p53371190">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_0020237255__p28099101">Failed to complete the request because of an internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row32688750164938"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p30543097164938">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_0020237255__p58071768164938">Failed to complete the request because the server does not support the requested function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row11809518164943"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p17046908164943">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_0020237255__p38622347164943">Failed to complete the request because the request is invalid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row38399341164956"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p23338889164956">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_0020237255__p11401882164956">Failed to complete the request because the service is unavailable.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0020237255__row51565323"><td class="cellrowborder" valign="top" width="43.419999999999995%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020237255__p16041657">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_0020237255__p24305815">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0020237255__section51311416428"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0020237255__p17841651174216">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>
|
|
|