vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/csbs/api-ref/en-us_topic_0059304223.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

1045 lines
90 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304223"></a><a name="EN-US_TOPIC_0059304223"></a>
<h1 class="topictitle1">Creating a Backup Policy</h1>
<div id="body65390118"><div class="section" id="EN-US_TOPIC_0059304223__section31829604"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0059304223__p157233831118">This API is used to create a backup policy to back up servers periodically.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304223__section18030987"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304223__ul64706547"><li id="EN-US_TOPIC_0059304223__li45488019">URI format<p id="EN-US_TOPIC_0059304223__p6738993"><a name="EN-US_TOPIC_0059304223__li45488019"></a><a name="li45488019"></a>POST https://{endpoint}/v1/{project_id}/policies</p>
</li><li id="EN-US_TOPIC_0059304223__li60650942">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table8987571" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row23300495"><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_0059304223__p8291924">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_0059304223__p557258">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_0059304223__p45137944">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_0059304223__p32294887">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row65749087"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p24075815">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_0059304223__p3983975">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_0059304223__p54266568">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_0059304223__p65779720">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304223__section28061156"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304223__ul30432523"><li id="EN-US_TOPIC_0059304223__li5457258">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table49115326" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row21353276"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p51893763">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p42645295">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p31716904">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p18932437">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row57132447"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p64325485">policy</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p42981800">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p58973751">policy_create</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p12144515">Creation parameters</p>
<p id="EN-US_TOPIC_0059304223__p42412300618">For details, see <a href="#EN-US_TOPIC_0059304223__table44181619">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li42191771">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b3010817">policy_create</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table44181619"></a><a name="table44181619"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table44181619" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b2129327439">policy_create</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row11627299"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p2287175">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p51043450">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p40878823">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p22850356">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row38939529"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p67094159">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p65917805">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p37742028">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p27265077155440">Backup policy description</p>
<p id="EN-US_TOPIC_0059304223__p37205460">The value consists of 0 to 255 characters and must not contain a greater-than sign (&gt;) or less-than sign (&lt;).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row66413686"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p10799501">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p2344417">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p55680089">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p48189633155443">Backup policy name</p>
<p id="EN-US_TOPIC_0059304223__p13793374">The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row57031504"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p56149139">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p51786390">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p33948033">policy_param</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p65436157">Backup parameters</p>
<p id="EN-US_TOPIC_0059304223__p817913224114">For details, see <a href="#EN-US_TOPIC_0059304223__table37852877">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row52054505"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p55665344">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p12599036">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p13889029">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p51269570">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304223__b23821012346">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row58772952"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p62988671">resources</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p1808718">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p12288494">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p55843975">Backup object list. The list can be blank.</p>
<p id="EN-US_TOPIC_0059304223__p144001011102416">For details, see <a href="#EN-US_TOPIC_0059304223__table50789269">Table 5</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row32833728"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p42286272">scheduled_operations</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p2635980">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p12187853">List&lt;scheduled_operation_create&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p47692075">Scheduling period</p>
<p id="EN-US_TOPIC_0059304223__p133820551248">For details, see <a href="#EN-US_TOPIC_0059304223__table23951472">Table 6</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row15378171794412"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p1937919174449">tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p1737931718448">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1737971714449">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p9244511113310">Tag list</p>
<p id="EN-US_TOPIC_0059304223__p52026988">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0059304223__p183916535015">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0059304223__p1338589319">Keys in this list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li26575496">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b26218460">policy_param</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table37852877"></a><a name="table37852877"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table37852877" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b50357604">policy_param</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row29126361"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p10425022">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p39120468">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p14641346">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p45098417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row29093193"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p7738417">common</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p22832017">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p37454098">common_param</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p13883099">General backup policy parameters, which are blank by default</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li57839035">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b13287175">resource</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table50789269"></a><a name="table50789269"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table50789269" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b18916858464">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row18650410"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.4.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p34288278">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.4.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p25887101">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.4.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p16480457">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.4.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p59848674">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row15904431"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p13190553">id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p61801863">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p39895010">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p28168574">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row7468195183617"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p10242210163618">type</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p18242710183616">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p182422103364">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1251341411205">Entity object type of backup objects</p>
<p id="EN-US_TOPIC_0059304223__p424214104366">The value is fixed at <strong id="EN-US_TOPIC_0059304223__b16607524864">OS::Nova::Server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row49383080"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p40606554">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p796601">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p64524716">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p45273784">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row1777116512367"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p777318533616">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p877312516363">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p10773185103617">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1677325193612">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li62313598">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b46687245">scheduled_operation_create</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table23951472"></a><a name="table23951472"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table23951472" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b1216315418">scheduled_operation_create</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row24217494"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.5.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p15460030">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.5.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p44302902">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.5.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p31765286">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.5.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p22851383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row39022736"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p6725082">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p7860797">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p32744800">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p54572478155517">Scheduling period description</p>
<p id="EN-US_TOPIC_0059304223__p35083115">The value consists of 0 to 255 characters and must not contain a greater-than sign (&gt;) or less-than sign (&lt;).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row47312583"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p7114051">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p39367226">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p34628758">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p62730120155515">Whether the backup policy is enabled</p>
<p id="EN-US_TOPIC_0059304223__p53466047">If it is set to <strong id="EN-US_TOPIC_0059304223__b38520628154040">true</strong>, automatic scheduling is enabled. If it is set to <strong id="EN-US_TOPIC_0059304223__b1125921504154042">false</strong>, automatic scheduling is disabled but you can execute the policy manually.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row11432380"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p53607554">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p47244617">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1608760">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p64762572155525">Scheduling period name</p>
<p id="EN-US_TOPIC_0059304223__p63200760">The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row31935934"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p36673850">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p17791834">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p31852422">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p29909415">Operation type</p>
<p id="EN-US_TOPIC_0059304223__p749287">Enumeration values: <strong id="EN-US_TOPIC_0059304223__b13695184417270">backup</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row6743589"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p9359847">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p19950166">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p5350745">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p30757209">Scheduling period parameters</p>
<p id="EN-US_TOPIC_0059304223__p161223012915">For details, see <a href="#EN-US_TOPIC_0059304223__table19271238">Table 7</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row8379427"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.5.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p7644968">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p15262686">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.5.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p28318060">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.5.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p12061563">Scheduling policy</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li46880491">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b20463720">operation_definition</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table19271238"></a><a name="table19271238"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table19271238" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b62974848">operation_definition</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row45318420"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.6.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p46913442">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.6.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p41892468">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.6.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p37846771">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.6.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p45689606">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row9870614"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p61322250">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p1046347">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p19751145134313">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p155661712122915">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="EN-US_TOPIC_0059304223__b5933112273519">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304223__b1668289357">0</strong> to <strong id="EN-US_TOPIC_0059304223__b090293123511">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304223__b135422352355">-1</strong>, backups will not be cleared by quantity limit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row45592928"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p2039720">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p30999616">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1736144219433">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1256618126294">Duration of retaining a backup, in days. The value can be <strong id="EN-US_TOPIC_0059304223__b12453130143813">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304223__b24535053817">0</strong> to <strong id="EN-US_TOPIC_0059304223__b13454003388">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304223__b09201952104517">-1</strong>, backups will not be cleared by retention duration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row34962829"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p13416914">permanent</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p13028235">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1756314017434">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p48669051">Whether backups are permanently retained. <strong id="EN-US_TOPIC_0059304223__b331116714482">false</strong>: no. <strong id="EN-US_TOPIC_0059304223__b38111194815">true</strong>: yes</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row162191159122615"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p6221105982614">plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p122219599269">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p322125992610">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p112212059192618">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row48704493272"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p1587014495279">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p78705492277">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p2870134912712">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p19870104917272">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304223__b1248303714810">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row133217534261"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p103231536262">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p173231534268">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p113231553152611">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p532385317262">Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and <strong id="EN-US_TOPIC_0059304223__b1765942714362">max_backups</strong> will both be applied. If this parameter is configured, <strong id="EN-US_TOPIC_0059304223__b1372363555013">timezone</strong> is mandatory.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row19217723192813"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p166229112817">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p162472902811">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p639329162812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p18444194418109">Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and <strong id="EN-US_TOPIC_0059304223__b13619855105119">max_backups</strong> will both be applied. If this parameter is configured, <strong id="EN-US_TOPIC_0059304223__b537271510536">timezone</strong> is mandatory.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row21651543162818"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p1116617434287">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p616604392817">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1916619435282">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p3166174318281">Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and <strong id="EN-US_TOPIC_0059304223__b228121117529">max_backups</strong> will both be applied. If this parameter is configured, <strong id="EN-US_TOPIC_0059304223__b14303540125317">timezone</strong> is mandatory.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row1078211192919"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p7915112162917">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p6920112182912">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p0933121252910">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1194121272917">Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and <strong id="EN-US_TOPIC_0059304223__b17124174875215">max_backups</strong> will both be applied. If this parameter is configured, <strong id="EN-US_TOPIC_0059304223__b57137509532">timezone</strong> is mandatory.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row19554162315296"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.6.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p175558232297">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p555552311290">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.6.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1255532311299">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.6.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1267113527713">Time zone where the user is located, for example, UTC+08:00. Set this parameter only after you have configured any of the parameters <strong id="EN-US_TOPIC_0059304223__b9978758155419">day_backups</strong>, <strong id="EN-US_TOPIC_0059304223__b2813142219555">week_backups</strong>, <strong id="EN-US_TOPIC_0059304223__b16365152595513">month_backups</strong>, and <strong id="EN-US_TOPIC_0059304223__b1418013013554">year_backups</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0059304223__note14845103425513"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0059304223__ul8260136185512"><li id="EN-US_TOPIC_0059304223__li1826063635517">If <strong id="EN-US_TOPIC_0059304223__b12442103810111">permanent</strong> is set to <strong id="EN-US_TOPIC_0059304223__b913104712114">true</strong>, backups will be retained permanently, despite the settings of <strong id="EN-US_TOPIC_0059304223__b647105518132">max_backups</strong> and <strong id="EN-US_TOPIC_0059304223__b988335711133">retention_duration_days</strong>.</li><li id="EN-US_TOPIC_0059304223__li62911736155519">If <strong id="EN-US_TOPIC_0059304223__b1351719453157">permanent</strong> is set to <strong id="EN-US_TOPIC_0059304223__b1910818489156">false</strong>, settings of <strong id="EN-US_TOPIC_0059304223__b1338335115157">max_backups</strong> and <strong id="EN-US_TOPIC_0059304223__b19239135661514">retention_duration_days</strong> are effective.</li><li id="EN-US_TOPIC_0059304223__li1330773619555">If none of <strong id="EN-US_TOPIC_0059304223__b4372125201612">permanent</strong>, <strong id="EN-US_TOPIC_0059304223__b58458811615">max_backups</strong>, and <strong id="EN-US_TOPIC_0059304223__b02351413101612">retention_duration_days</strong> is set, backups will be retained permanently.</li></ul>
</div></div>
</li><li id="EN-US_TOPIC_0059304223__li35368277">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b38758958">trigger</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table49879041" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b64744584">trigger</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row47309752"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.7.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p6884678">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.7.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p20788012">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.7.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p6107411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.7.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p24938274">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row6734338"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.7.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p8610523">properties</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.7.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p26363732">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.7.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p55087509">trigger_properties</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.7.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p32903239">Scheduler properties</p>
<p id="EN-US_TOPIC_0059304223__p988542119125">For details, see <a href="#EN-US_TOPIC_0059304223__table47916689">Table 9</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li27693697">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b2803303">trigger_properties</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table47916689"></a><a name="table47916689"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table47916689" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b5126234">trigger_properties</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row23274163"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.8.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p6159059">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.8.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p29121751">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.8.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p10051624">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.8.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p8875181">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row47801038"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.8.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p46678901">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.8.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p22894599">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.8.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p42523246">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.8.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p1462194645616">Scheduling policy of the scheduler. The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are <strong id="EN-US_TOPIC_0059304223__b493883467145715">FREQ</strong>, <strong id="EN-US_TOPIC_0059304223__b1937275926145715">BYDAY</strong>, <strong id="EN-US_TOPIC_0059304223__b1612469200145715">BYHOUR</strong>, and <strong id="EN-US_TOPIC_0059304223__b390004774145715">BYMINUTE</strong>. <strong id="EN-US_TOPIC_0059304223__b1516398839145715">FREQ</strong> can be set only to <strong id="EN-US_TOPIC_0059304223__b224731310145715">WEEKLY</strong> or <strong id="EN-US_TOPIC_0059304223__b1900044038145715">DAILY</strong>. <strong id="EN-US_TOPIC_0059304223__b23610045145715">BYDAY</strong> can be set to <strong id="EN-US_TOPIC_0059304223__b815356244145715">MO</strong>, <strong id="EN-US_TOPIC_0059304223__b459345718145715">TU</strong>, <strong id="EN-US_TOPIC_0059304223__b782468707145715">WE</strong>, <strong id="EN-US_TOPIC_0059304223__b1340771475145715">TH</strong>, <strong id="EN-US_TOPIC_0059304223__b399493889145715">FR</strong>, <strong id="EN-US_TOPIC_0059304223__b588657796145715">SA</strong>, or <strong id="EN-US_TOPIC_0059304223__b1417324580145715">SU</strong> (seven days of a week). <strong id="EN-US_TOPIC_0059304223__b1173680002145715">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="EN-US_TOPIC_0059304223__b1323451016145715">BYMINUTE</strong> ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li62260646">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b84235270695528">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table1431115645119" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b15966102216715">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row4339106155119"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.9.2.2.5.1.1"><p id="EN-US_TOPIC_0059304223__p1334796195117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.9.2.2.5.1.2"><p id="EN-US_TOPIC_0059304223__p163543612513">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.9.2.2.5.1.3"><p id="EN-US_TOPIC_0059304223__p193627619517">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.9.2.2.5.1.4"><p id="EN-US_TOPIC_0059304223__p73671062515">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row63768665110"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.9.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p10380567512">key</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.9.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p1938817615112">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.9.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1739414617517">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.9.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p798643483310">Tag key</p>
<p id="EN-US_TOPIC_0059304223__p036816391334">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304223__p1815945343312">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304223__p139819543334">Spaces before and after a key will be deprecated.</p>
<p id="EN-US_TOPIC_0059304223__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row1116111556513"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.9.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304223__p1816118554511">value</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.9.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304223__p1516145585115">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.9.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304223__p1116145519518">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.9.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304223__p11608421163420">Tag value</p>
<p id="EN-US_TOPIC_0059304223__p489413816351">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304223__p14194717123517">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304223__p1146913338362">Spaces before and after a tag value will be deprecated.</p>
<p id="EN-US_TOPIC_0059304223__p1317535564114">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0059304223__ul93860168508"><li id="EN-US_TOPIC_0059304223__li13386816195010">Example request<pre class="screen" id="EN-US_TOPIC_0059304223__screen1885578171610">POST https://{endpoint}/v1/{project_id}/policies
{
"policy" : {
"name" : "my-plan",
"description" : "My plan",
"provider_id" : "fc4d5750-22e7-4798-8a46-f48f62c4c1da",
"parameters" : {
"common" : {
}
},
"scheduled_operations" : [ {
"name" : "my-backup-policy",
"description" : "My backup policy",
"enabled" : true,
"operation_definition" : {
"max_backups" : 20
},
"trigger" : {
"properties" : {
"pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n"
}
},
"operation_type" : "backup"
}
],
"resources" : [ {
"id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
"type" : "OS::Nova::Server",
"name" : "resource1",
}, {
"id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"type" : "OS::Nova::Server",
"name" : "resource2"
} ]
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0059304223__section51223818"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304223__ul60966246"><li id="EN-US_TOPIC_0059304223__li11825308">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table39318913" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row29321872"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p26261412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p32672922">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p29261003">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row21331074"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p50095396">policy</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p43790671">policy_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p57383463">For details, see <a href="#EN-US_TOPIC_0059304223__table17548940">Table 12</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li46689124">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b53180163">policy_resp</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table17548940"></a><a name="table17548940"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table17548940" frame="border" border="1" rules="all"><caption><b>Table 12 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b37105186">policy_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row28512063"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p27775771">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p36270756">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p52250146">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row4403408"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p21131734">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p65505804">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p4369932">Creation time, for example, <strong id="EN-US_TOPIC_0059304223__b4510143014819">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row39329394"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p31564334">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p62749946">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p33604774155631">Backup policy description</p>
<p id="EN-US_TOPIC_0059304223__p49580891">The value consists of 0 to 255 characters and must not contain a greater-than sign (&gt;) or less-than sign (&lt;).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row43574843"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p39901414">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p1503005">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p54634618">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row21949517"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p33080433">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p10657415">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p11959167155632">Backup policy name</p>
<p id="EN-US_TOPIC_0059304223__p57944264">The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row51736335"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p29893639">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p40066831">policy_param</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p24187888">Parameters of a backup policy</p>
<p id="EN-US_TOPIC_0059304223__p1285817314139">For details, see <a href="#EN-US_TOPIC_0059304223__table60850186">Table 13</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row16364404"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p50448361">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p10781336">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p872994">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row7856948"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p32433056">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p58184521">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p15325783">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304223__b132869713397">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row3714320"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p32424509">resources</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p2109397">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p36643472">Backup object list</p>
<p id="EN-US_TOPIC_0059304223__p031412112386">For details, see <a href="#EN-US_TOPIC_0059304223__table8223017">Table 14</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row61355793"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p3763354">scheduled_operations</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p62413236">List&lt;scheduled_operation_resp&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p22307350">Scheduling period list</p>
<p id="EN-US_TOPIC_0059304223__p721416394102">For details, see <a href="#EN-US_TOPIC_0059304223__table27342530">Table 15</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row66548424"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p21713302">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p55969127">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p673245135219">Backup policy status</p>
<p id="EN-US_TOPIC_0059304223__p41984995213"><strong id="EN-US_TOPIC_0059304223__b1250102492416">disabled</strong>: indicates that the backup policy is unavailable.</p>
<p id="EN-US_TOPIC_0059304223__p37205434"><strong id="EN-US_TOPIC_0059304223__b842352706201847">enabled</strong>: indicates that the backup policy is available.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row22241337193112"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p174623437319">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p3491104316311">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p205016435313">Tag list</p>
<p id="EN-US_TOPIC_0059304223__p195066436315">Keys in the tag list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li66413455">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b61945765">policy_param</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table60850186"></a><a name="table60850186"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table60850186" frame="border" border="1" rules="all"><caption><b>Table 13 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b01271524718">policy_param</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row55096853"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p33660148">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p56074324">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p45726372">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row12848661"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p34108622">common</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p45722427">common_param</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p12529086">Common parameters of a backup policy</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li45652911">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b712365145">resource</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table8223017"></a><a name="table8223017"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table8223017" frame="border" border="1" rules="all"><caption><b>Table 14 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b17748857575">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row13206884"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p63124717">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p32472196">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p13002210">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row46546093"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p12137164">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p40822568">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p18293684">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row30425435"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p48541157">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p46976228">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p135595518209">Entity object type of backup objects</p>
<p id="EN-US_TOPIC_0059304223__p46978087">The value is fixed at <strong id="EN-US_TOPIC_0059304223__b9971431101618">OS::Nova::Server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row20149607"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p21505479">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p34617244">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p52533345">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row1335872524012"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p17358925104016">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p835802519403">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p1235852516402">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li3038058">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b19683111">scheduled_operation_resp</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table27342530"></a><a name="table27342530"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table27342530" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b65337652">scheduled_operation_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row11737145"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.5.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p11184698">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.5.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p32818621">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.5.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p41062672">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row37742115"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p37212446">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p8814574">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p63816818155656">Scheduling period description</p>
<p id="EN-US_TOPIC_0059304223__p42891923">The value consists of 0 to 255 characters and must not contain a greater-than sign (&gt;) or less-than sign (&lt;).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row50482993"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p62590666">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p18224513">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p4722803815572">Whether the scheduling period is enabled</p>
<p id="EN-US_TOPIC_0059304223__p66899439">The default value is <strong id="EN-US_TOPIC_0059304223__b7338628155344">true</strong>. If it is set to <strong id="EN-US_TOPIC_0059304223__b40578736155344">false</strong>, automatic scheduling is disabled but manual scheduling is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row65224043"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p48656155">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p63280397">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p1565991715579">Scheduling period name</p>
<p id="EN-US_TOPIC_0059304223__p25438494">The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row27619857"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p22615970">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p5687234">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p19973119194519">Operation type</p>
<p id="EN-US_TOPIC_0059304223__p1698917917456">Enumeration values: <strong id="EN-US_TOPIC_0059304223__b18484193192813">backup</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row1419028"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p47832452">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p27671161">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p26771534">Scheduling period parameters</p>
<p id="EN-US_TOPIC_0059304223__p184682714386">For details, see <a href="#EN-US_TOPIC_0059304223__table63384596">Table 16</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row39617215"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p54877886">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p14760542">trigger_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p54753230">Scheduling policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row23017027"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p52439899">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p58144793">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p12107791">Scheduling period ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row41861256"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p35318547">trigger_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p65191939">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p46055736">Scheduler ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li44325435">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b574863916">operation_definition</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table63384596"></a><a name="table63384596"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table63384596" frame="border" border="1" rules="all"><caption><b>Table 16 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b181618501810">operation_definition</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row54750588"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.6.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p5612672">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.6.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p49086813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.6.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p16608902">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row3143820"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p53322838">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p12633944">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p57317856">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="EN-US_TOPIC_0059304223__b16498172195413">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304223__b14995295418">0</strong> to <strong id="EN-US_TOPIC_0059304223__b124994275418">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304223__b124224236719">-1</strong>, backups will not be cleared by quantity limit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row16230877"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p39632683">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p50295167">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p33411543">Duration of retaining a backup, in days. The value can be <strong id="EN-US_TOPIC_0059304223__b315941715418">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304223__b7159181711542">0</strong> to <strong id="EN-US_TOPIC_0059304223__b2160151765419">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304223__b183403271711">-1</strong>, backups will not be cleared by retention duration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row23737353"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p43677444">permanent</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p12862047">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p35192847">Whether backups are permanently retained</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row144931911132919"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p1949381111299">plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p549316116294">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p449312113298">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row09311432202917"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p99311232192910">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p169311132102916">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p193183282917">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304223__b994213206547">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0059304223__note1314114577508"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0059304223__ul8882748125117"><li id="EN-US_TOPIC_0059304223__li17527017374">If <strong id="EN-US_TOPIC_0059304223__b15359134942418">permanent</strong> is set to <strong id="EN-US_TOPIC_0059304223__b15359164910248">true</strong>, backups will be retained permanently, despite the settings of <strong id="EN-US_TOPIC_0059304223__b935934911243">max_backups</strong> and <strong id="EN-US_TOPIC_0059304223__b135994922420">retention_duration_days</strong>.</li><li id="EN-US_TOPIC_0059304223__li18542201718710">If <strong id="EN-US_TOPIC_0059304223__b91624528245">permanent</strong> is set to <strong id="EN-US_TOPIC_0059304223__b816425232411">false</strong>, settings of <strong id="EN-US_TOPIC_0059304223__b171651052112419">max_backups</strong> and <strong id="EN-US_TOPIC_0059304223__b121659521249">retention_duration_days</strong> are effective.</li><li id="EN-US_TOPIC_0059304223__li1355814179712">If none of <strong id="EN-US_TOPIC_0059304223__b14336055142420">permanent</strong>, <strong id="EN-US_TOPIC_0059304223__b18337655122413">max_backups</strong>, and <strong id="EN-US_TOPIC_0059304223__b233717552245">retention_duration_days</strong> is set, backups will be retained permanently.</li></ul>
</div></div>
</li><li id="EN-US_TOPIC_0059304223__li48300168">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b61629280">trigger_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table32048331" frame="border" border="1" rules="all"><caption><b>Table 17 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b56369192">trigger_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row2735555"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.7.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p20253366">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.7.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p6789872">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.7.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p13108741">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row55175115"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p39999337">properties</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p39998288">trigger_properties_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p18635880">Scheduler properties</p>
<p id="EN-US_TOPIC_0059304223__p103468911421">For details, see <a href="#EN-US_TOPIC_0059304223__table55128598">Parameter description of field trigger_properties_resp</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row33505193"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p29566141">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p38837434">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p58824435">Scheduler ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row59657871"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p449362">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p62583865">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p36128301">Scheduler name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row56719260"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p30857368">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p54863582">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p14765176">Scheduling type. The value is fixed at <strong id="EN-US_TOPIC_0059304223__b48822022195311">time</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li65777723">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b50966358">trigger_properties_resp</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304223__table55128598"></a><a name="table55128598"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table55128598" frame="border" border="1" rules="all"><caption><b>Table 18 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b32538658">trigger_properties_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row731260"><th align="left" class="cellrowborder" valign="top" width="30.23%" id="mcps1.3.5.2.8.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p59232061">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.28%" id="mcps1.3.5.2.8.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p61232441">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.49%" id="mcps1.3.5.2.8.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p60880708">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row32390328"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.5.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p6370875">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.5.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p57603733">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p487511155745">Scheduling policy of the scheduler</p>
<p id="EN-US_TOPIC_0059304223__p35390778">The value consists of a maximum of 10,240 characters. The scheduling policy complies with iCalendar RFC 2445, but it supports only four parameters, which are <strong id="EN-US_TOPIC_0059304223__b43574134475">FREQ</strong>, <strong id="EN-US_TOPIC_0059304223__b1994381524711">BYDAY</strong>, <strong id="EN-US_TOPIC_0059304223__b83981318174710">BYHOUR</strong>, and <strong id="EN-US_TOPIC_0059304223__b452518219472">BYMINUTE</strong>. <strong id="EN-US_TOPIC_0059304223__b107764239472">FREQ</strong> can be set to <strong id="EN-US_TOPIC_0059304223__b0988182634711">WEEKLY</strong> and <strong id="EN-US_TOPIC_0059304223__b144771136184711">DAILY</strong>, <strong id="EN-US_TOPIC_0059304223__b972143934713">BYDAY</strong> can be set to <strong id="EN-US_TOPIC_0059304223__b139669424472">MO</strong>, <strong id="EN-US_TOPIC_0059304223__b4777466475">TU</strong>, <strong id="EN-US_TOPIC_0059304223__b1961524924719">WE</strong>, <strong id="EN-US_TOPIC_0059304223__b13789115424710">TH</strong>, <strong id="EN-US_TOPIC_0059304223__b17733103044816">FR</strong>, <strong id="EN-US_TOPIC_0059304223__b14380143419484">SA</strong>, and <strong id="EN-US_TOPIC_0059304223__b8756144212483">SU</strong> (seven days of a week), <strong id="EN-US_TOPIC_0059304223__b8159184654817">BYHOUR</strong> ranges from 0 hours to 23 hours, and <strong id="EN-US_TOPIC_0059304223__b3846204834812">BYMINUTE</strong> ranges from 0 minutes to 59 minutes. The scheduling interval must not be less than 1 hour. A maximum of 24 time points are allowed in a day.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row50081552"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.5.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p30073877">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.5.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p14648285">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p45660399">Scheduler start time, for example, <strong id="EN-US_TOPIC_0059304223__b1947952945417">2017-04-18T01:21:52</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row84596471868"><td class="cellrowborder" valign="top" width="30.23%" headers="mcps1.3.5.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p12460447864">format</p>
</td>
<td class="cellrowborder" valign="top" width="16.28%" headers="mcps1.3.5.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p94608471263">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.49%" headers="mcps1.3.5.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p1446094716618">Scheduler type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li12837101018321">Parameter description of field <strong id="EN-US_TOPIC_0059304223__b928466849">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table417313521868" frame="border" border="1" rules="all"><caption><b>Table 19 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304223__b1038472196">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304223__row92031852365"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.9.2.2.4.1.1"><p id="EN-US_TOPIC_0059304223__p8210115219610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.9.2.2.4.1.2"><p id="EN-US_TOPIC_0059304223__p322712521565">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.9.2.2.4.1.3"><p id="EN-US_TOPIC_0059304223__p172363521662">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row1925014528611"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p20260195214611">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p1927719521763">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0059304223__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304223__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304223__p10562107145513">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row230320521160"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304223__p11311752965">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304223__p1432910527614">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304223__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0059304223__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304223__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304223__p17281181312551">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li8290413">Example response<pre class="screen" id="EN-US_TOPIC_0059304223__screen874263601615">{
"policy" : {
"created_at" : "2017-03-07T09:27:40.928000",
"description" : "My plan",
"id" : "f766c171-9336-479a-8b30-b83cabf6381e",
"name" : "my-plan",
"parameters" : {
"common" : {
}
},
"project_id" : "tenant",
"provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec",
"resources" : [ {
"id" : "45baf976-c20a-4894-a7c3-c94b7376bf55",
"name" : "resource1",
"type" : "OS::Nova::Server",
"extra_info" : {
}
}, {
"id" : "5aa119a8-d25b-45a7-8d1b-88e127885635",
"name" : "resource2",
"type" : "OS::Nova::Server"
} ],
"scheduled_operations" : [ {
"description" : "My backup policy",
"enabled" : true,
"id" : "9303a23d-e433-48e7-b88a-5ee6442e434e",
"name" : "my-backup-policy",
"operation_definition" : {
"max_backups" : "20",
"plan_id" : "f766c171-9336-479a-8b30-b83cabf6381e",
"provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
},
"operation_type" : "backup",
"trigger" : {
"id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9",
"name" : "default",
"properties" : {
"pattern" : "BEGIN:VCALENDAR\r\nBEGIN:VEVENT\r\nRRULE:FREQ=WEEKLY;BYDAY=TH;BYHOUR=12;BYMINUTE=27\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
"start_time" : "2017-03-07 09:27:41",
"format" : "ical"
},
"type" : "time"
},
"trigger_id" : "8178846b-766d-4fe6-941f-b38c76b6f3b9"
}
,
],
"status" : "suspended"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304223__section58361181"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304223__ul19849672"><li id="EN-US_TOPIC_0059304223__li44429325">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table64319608" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304223__row49498453"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304223__p49951763">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.6.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304223__p19561042">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row40940602"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p27854450">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p41617954">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304223__li39017271">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304223__table15611123" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304223__row13876685"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304223__p50269699">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304223__p45313789">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304223__row46538275"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p11503967">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p59406102">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row64892876"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p21831626">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p23531256">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row10454712"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p41525362">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p208782512197">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row5891508"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p7450164">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p66592429">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row62460950"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p26172150">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p39569378">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304223__row20580089"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304223__p56374499">503</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304223__p2931726">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304223__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304223__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_0059304222.html">Backup Policy Management</a></div>
</div>
</div>
View Git Blame Copy Permalink