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

321 lines
27 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0043410517"></a><a name="EN-US_TOPIC_0043410517"></a>
<h1 class="topictitle1">Creating a Backup Policy</h1>
<div id="body1480660600412"><div class="section" id="EN-US_TOPIC_0043410517__section63962185"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0043410517__p23236933">This API is used to create a backup policy. A tenant can create a maximum of 10 backup policies.</p>
</div>
<div class="section" id="EN-US_TOPIC_0043410517__section38788755"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0043410517__ul3143429"><li id="EN-US_TOPIC_0043410517__li28290863">URI format<p id="EN-US_TOPIC_0043410517__p9858548"><a name="EN-US_TOPIC_0043410517__li28290863"></a><a name="li28290863"></a>POST /v2/{project_id}/backuppolicy</p>
</li><li id="EN-US_TOPIC_0043410517__li21618074">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0043410517__table60344938" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__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_0043410517__p58179688">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__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_0043410517__p64170449">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0043410517__section13554483"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0043410517__ul30423852"><li id="EN-US_TOPIC_0043410517__li5379216">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0043410517__table48412952" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0043410517__row28932175"><th align="left" class="cellrowborder" valign="top" width="26.697330266973307%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0043410517__p61804813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.968703129687032%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0043410517__p40133923">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.35836416358364%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0043410517__p14225104112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.97560243975603%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0043410517__p29622330">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0043410517__row187031441791"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p385596811791">backup_policy_name</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p363264551791">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p567617131791">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p342960231791">Backup policy name</p>
<p id="EN-US_TOPIC_0043410517__p3925774164959">The name is a string of 1 to 64 characters consisting of letters, digits, underscores (_), and hyphens (-). It cannot start with <strong id="EN-US_TOPIC_0043410517__b8423527069400">default</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row50598521"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p44217312144451">scheduled_policy</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p56460178">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p1152258104112">dict</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p9871675">Details about the scheduling policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row21736211"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p43785202144538">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p4945408">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p26224039104112">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p7157111116351">Backup execution time (UTC), in the format of <strong id="EN-US_TOPIC_0043410517__b842352706174833_1">HH:mm</strong></p>
<p id="EN-US_TOPIC_0043410517__p3257181317204">You need to set the execution time to a full hour. You can set multiple execution times, and use commas (,) to separate one time from another. To set multiple backup execution times, enter them in ascending order by local time. For example, if your local time is 2 hours ahead of UTC and you want to perform backups at the local times 00:00, 02:00, and 04:00, set this parameter to <strong id="EN-US_TOPIC_0043410517__b12146123873213">22:00,00:00,02:00</strong> (UTC times) and <strong id="EN-US_TOPIC_0043410517__b154951141203214">time_zone</strong> to <strong id="EN-US_TOPIC_0043410517__b9926184617325">UTC+02:00</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row48433347"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p37214191144556">frequency</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p10722842">No (Either this field or <strong id="EN-US_TOPIC_0043410517__b16479447104913">week_frequency</strong> must be specified.)</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p43772392104112">integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p56717145145258">Backup interval (1 to 14 days). Set either this parameter or <strong id="EN-US_TOPIC_0043410517__b1053274115717">week_frequency</strong>. If you set both, this parameter is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row12854125121513"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p11855851121516">week_frequency</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p14855251121517">No (Either this field or <strong id="EN-US_TOPIC_0043410517__b16356111443010">frequency</strong> must be specified.)</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p9855351121511">list&lt;string&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p1285535171516">Defines on which days of each week backup jobs are executed. The value can be one or more of the following:</p>
<p id="EN-US_TOPIC_0043410517__p17960105519177">SUN, MON, TUE, WED, THU, FRI, SAT</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row52369142144652"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p45086190144659">rentention_num</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p102291014472">No (Either this field or <strong id="EN-US_TOPIC_0043410517__b2999141613506">rentention_day</strong> must be specified.)\</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p57109303144652">integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p50469373145310">Number (from 2 to 14) of retained backups. Set either this parameter or <strong id="EN-US_TOPIC_0043410517__b13739163920509">rentention_day</strong>. If you set both, this parameter is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row123431657111518"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p16343145717151">rentention_day</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p12343175713159">No (Either this field or <strong id="EN-US_TOPIC_0043410517__b10619648202514">rentention_num</strong> must be specified.)</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p33437575151">integer</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p53437576151">Retention days of backups. The value is an integer ranging from 2 to 99999. If you enter a floating point number, the number will be rounded down to the nearest integer when you send the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row13400247144843"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p26845495144845">remain_first_backup_of_curMonth</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p6410995144843">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p49528559144843">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p52390368144843">Whether to retain the first backup in the current month</p>
<ul id="EN-US_TOPIC_0043410517__ul10334226145125"><li id="EN-US_TOPIC_0043410517__li62697321145125">Y</li><li id="EN-US_TOPIC_0043410517__li28750170145129">N</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row36885943144931"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p34971403144931">status</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p14111424144931">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p2174718144931">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p37418078145334">Backup policy status</p>
<ul id="EN-US_TOPIC_0043410517__ul3077574414513"><li id="EN-US_TOPIC_0043410517__li1908776214513">ON</li><li id="EN-US_TOPIC_0043410517__li1764699714517">OFF</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row58916789112314"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p7102168112438">tags</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p38404722112438">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p23774797112438">list&lt;dict&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p46710417112438">Tags to be configured for the backup policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row5274002112431"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p27699980112438">key</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p29105916112438">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p8768976112438">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p39198449112438">Tag key. It contains 1 to 36 characters, A tag key can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row36477860112435"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p54402167112438">value</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p44499446112438">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p47685406112438">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p37312662112438">Tag value. A tag value consists of 0 to 43 characters. A tag value can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row781662417237"><td class="cellrowborder" valign="top" width="26.697330266973307%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0043410517__p281672492310">time_zone</p>
</td>
<td class="cellrowborder" valign="top" width="12.968703129687032%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0043410517__p13816324162312">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.35836416358364%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0043410517__p88163249236">string</p>
</td>
<td class="cellrowborder" valign="top" width="43.97560243975603%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0043410517__p134451014203612">Time zone. The value is in the UTC+/-HH:mm format.</p>
<p id="EN-US_TOPIC_0043410517__p13467818248">This parameter specifies the time zone of the local time with the Daylight Saving Time (DST) offset, for example, UTC+08:00 or UTC-02:00. If execution times are in different days after converting into UTC times, this parameter must be used with <strong id="EN-US_TOPIC_0043410517__b20983644203010">week_frequency</strong> and <strong id="EN-US_TOPIC_0043410517__b16826311144311">start_time</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0043410517__ul22483156"><li id="EN-US_TOPIC_0043410517__li1021814">Example request<pre class="screen" id="EN-US_TOPIC_0043410517__screen1850941114274">{
"backup_policy_name": "policy_01",
"scheduled_policy" : {
"remain_first_backup_of_curMonth" : "Y",
"rentention_day" : 30,
"week_frequency" : ["SUN","WED"],
"start_time" : "12:00",
"status" : "ON"
},
"tags":[{
"key":"key",
"value":"value"
}],
"time_zone": "UTC+08:00"
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0043410517__section54881489"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0043410517__ul20896204"><li id="EN-US_TOPIC_0043410517__li2520711120254">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0043410517__table2553741120254" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0043410517__row84520220254"><th align="left" class="cellrowborder" valign="top" width="29.182918291829186%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0043410517__p1395841219362">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.471547154715473%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0043410517__p7974141283610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.345534553455344%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0043410517__p149741312153614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0043410517__row894248020254"><td class="cellrowborder" valign="top" width="29.182918291829186%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0043410517__p34048608151944">backup_policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.471547154715473%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0043410517__p4563373217131">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.345534553455344%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0043410517__p1948402220254">Backup policy ID returned if the operation is successful</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row4113847020254"><td class="cellrowborder" valign="top" width="29.182918291829186%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0043410517__p4388173520254">message</p>
</td>
<td class="cellrowborder" valign="top" width="15.471547154715473%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0043410517__p534483917131">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.345534553455344%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0043410517__p1103955520254">Error message returned after an error occurs</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__row3224713720254"><td class="cellrowborder" valign="top" width="29.182918291829186%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0043410517__p6188131520254">code</p>
</td>
<td class="cellrowborder" valign="top" width="15.471547154715473%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0043410517__p3027879417131">string</p>
</td>
<td class="cellrowborder" valign="top" width="55.345534553455344%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0043410517__p6179451720254">Error code returned after an error occurs</p>
<p id="EN-US_TOPIC_0043410517__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_0043410517__li53848109">Example response<pre class="screen" id="EN-US_TOPIC_0043410517__screen59065789101145">{
"backup_policy_id": "af8a20b0-117d-4fc3-ae53-aa3968a4f870"
}</pre>
<p id="EN-US_TOPIC_0043410517__p36388601">or</p>
<pre class="screen" id="EN-US_TOPIC_0043410517__screen20692691101149">{
"error": {
"code": "XXXX",
"message": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0043410517__section24171358"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0043410517__ul59834015"><li id="EN-US_TOPIC_0043410517__li1635228">Normal<p id="EN-US_TOPIC_0043410517__p14717055"><a name="EN-US_TOPIC_0043410517__li1635228"></a><a name="li1635228"></a>200</p>
</li><li id="EN-US_TOPIC_0043410517__li65344633">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0043410517__table51230787" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p12164329">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p26457778">The server failed to process the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p11009764">You must enter the username and password to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p32016662">You are forbidden to access the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p3802708716376">The server could not find the requested page.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p23586373163725">You are not allowed to use the method specified in the request.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p39357967163758">The response generated by the server could not be accepted by the client.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p20492948163754">You must use the proxy server for authentication so that the request can be processed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p1281119163738">The request timed out.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p59021712164354">The request could not be processed due to a conflict.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p28099101">Failed to complete the request because of an internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p58071768164938">Failed to complete the request because the server does not support the requested function.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p38622347164943">Failed to complete the request because the request is invalid.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p11401882164956">Failed to complete the request because the service is unavailable.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0043410517__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_0043410517__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_0043410517__p24305815">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0043410517__section1362310255432"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0043410517__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_0043410516.html">Backup Policies</a></div>
</div>
</div>
View Git Blame Copy Permalink