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

617 lines
49 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304227"></a><a name="EN-US_TOPIC_0059304227"></a>
<h1 class="topictitle1">Querying the Backup Policy List</h1>
<div id="body62123822"><div class="section" id="EN-US_TOPIC_0059304227__section37588797"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0059304227__p65973687">This API is used to query the backup policy list. Filtering parameters are supported.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304227__section2754853"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304227__ul42268465"><li id="EN-US_TOPIC_0059304227__li44871872">URI format<p id="EN-US_TOPIC_0059304227__p1193668"><a name="EN-US_TOPIC_0059304227__li44871872"></a><a name="li44871872"></a>GET https://{endpoint}/v1/{project_id}/policies</p>
</li><li id="EN-US_TOPIC_0059304227__li10743014">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table29578263" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row55030713"><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_0059304227__p45356064">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0059304227__p49962569">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0059304227__p20436323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0059304227__p44729494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row806275"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p65308318">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_0059304227__p55482381">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_0059304227__p64887865">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_0059304227__p65779720">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304227__section24793679"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304227__ul57757925"><li id="EN-US_TOPIC_0059304227__li50059284">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table47880374" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row8615968"><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_0059304227__p81019812473">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_0059304227__p15102081479">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_0059304227__p18101081479">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_0059304227__p325148194714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row18906739"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p55050930">limit</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_0059304227__p29940378">No</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_0059304227__p9251538">Integer</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_0059304227__p11177090">Number of resources displayed per page. The value must be a positive integer. The value defaults to <strong id="EN-US_TOPIC_0059304227__b18247153115518">1000</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row33484951"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p27926511">marker</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_0059304227__p47454932">No</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_0059304227__p18644269">String</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_0059304227__p33790819">ID of the last record displayed on the previous page when pagination query is applied</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row35681916"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p4554055">sort</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_0059304227__p33334179">No</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_0059304227__p15713975">String</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_0059304227__p64872492">The value of <strong id="EN-US_TOPIC_0059304227__b34759433">sort</strong> is a group of properties separated by commas (,) and sorting directions. The value format is &lt;key1&gt;[:&lt;direction&gt;],&lt;key2&gt;[:&lt;direction&gt;], where the value of direction is <strong id="EN-US_TOPIC_0059304227__b1273581669173844">asc</strong> (in ascending order) or <strong id="EN-US_TOPIC_0059304227__b421059629173844">desc</strong> (in descending order). If the parameter direction is not specified, backup policies are sorted in descending order by time. The value of <strong id="EN-US_TOPIC_0059304227__b788002962173844">sort</strong> contains a maximum of 255 characters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row46981522"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p47406971">name</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_0059304227__p14759448">No</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_0059304227__p54664658">String</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_0059304227__p65761168">Exact matching based on field <strong id="EN-US_TOPIC_0059304227__b41027498">name</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row54979604"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p24162964">all_tenants</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_0059304227__p11043085">No</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_0059304227__p22074662">Boolean</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_0059304227__p921691216449">Whether backup policies of all tenants can be queried</p>
<p id="EN-US_TOPIC_0059304227__p43217159">This parameter is only available for administrators.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row53410114"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304227__p31252003">offset</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_0059304227__p48384353">No</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_0059304227__p26818531">Integer</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_0059304227__p24817426">Offset value, which is a positive integer.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li22030245">Parameter description</li></ul>
<p id="EN-US_TOPIC_0059304227__p64054485">None</p>
<ul id="EN-US_TOPIC_0059304227__ul39619458"><li id="EN-US_TOPIC_0059304227__li21030805">Example request<pre class="screen" id="EN-US_TOPIC_0059304227__screen16424195261816">Querying all backup policies:
GET https://{endpoint}/v1/{project_id}/policies
Querying backup policies with certain conditions:
GET https://{endpoint}/v1/{project_id}/policies?sort=created_at%3Aasc&amp;limit=3&amp;offset=3</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304227__section21816525"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304227__ul30636036"><li id="EN-US_TOPIC_0059304227__li7288874">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table65599866" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row3333769"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p78731344718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p6102161317473">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p9102513174714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row33962906"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p66640864">policies</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p16460576">List&lt;policy_resp&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p760491412288">For details, see the <strong id="EN-US_TOPIC_0059304227__b89724121070">policy_resp</strong> field description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li54382796">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b37105186">policy_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table19683123" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b32051110193312">policy_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row33757491"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p272811199473">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p16728619134712">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p874381934711">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row62410315"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p22070716">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p52150808">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p63465939">Creation time, for example, <strong id="EN-US_TOPIC_0059304227__b1854418211776">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row34322544"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p28662703">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p16960338">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p25044971164419">Backup policy description</p>
<p id="EN-US_TOPIC_0059304227__p31610118">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_0059304227__row16055609"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p25435967">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p52747388">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p44680068">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row66576294"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p23970749">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p36021385">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p43152724164422">Backup policy name</p>
<p id="EN-US_TOPIC_0059304227__p32051086">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_0059304227__row20024320"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p11357251">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p24086321">policy_param</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p4834989">Parameters of a backup policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row43514905"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p35046384">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p24362293">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p27188722">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row43371912"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p23463983">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p66569886">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p23451703">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_0059304227__b1532195820912">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row9738736"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p50640112">resources</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p60899069">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p33877595">Backup object list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row36462904"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p705260">scheduled_operations</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p63808428">List&lt;scheduled_operation_resp&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p1100169">Scheduling period list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row9901523"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p63825892">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p2366474">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p57466737">Backup policy status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row164178313331"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p441718303317">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p16417932330">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p44179311333">Tag list</p>
<p id="EN-US_TOPIC_0059304227__p20418998516">Keys in the tag list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li47438585">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b50357604">policy_param</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table24294083" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b452612111334">policy_param</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row59113611"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p3946192354719">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p1946202394716">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p12962923104716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row17853234"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p36825846">common</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p22470857">common_param</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p8200103">General backup policy parameters, which are blank by default</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li6692063">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b41389494">resource</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table60228573" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b11889131213310">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row24510657"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p141036335476">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p1611811332473">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p15118833124716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row9935832"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p66604938">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p49189852">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p24955084">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row23269166"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p5754275">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p38621127">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p12469818162119">Entity object type of backup objects</p>
<p id="EN-US_TOPIC_0059304227__p41303622">The value is fixed at <strong id="EN-US_TOPIC_0059304227__b3891124291610">OS::Nova::Server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row36188286"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p45570016">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p14890379">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p65270051">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row42041022105013"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p777318533616">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p10773185103617">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p1677325193612">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li50559552">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b65337652">scheduled_operation_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table52382792" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b844281419332">scheduled_operation_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row32282907"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.5.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p1893113910472">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.5.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p39473396479">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.5.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p19947739114713">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row9730668"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p49986610">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p1133032">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p28250778164442">Scheduling period description</p>
<p id="EN-US_TOPIC_0059304227__p24666792">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_0059304227__row20674542"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p64025194">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p34918070">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p34970950164444">Whether the scheduling period is enabled</p>
<p id="EN-US_TOPIC_0059304227__p9791447">The default value is <strong id="EN-US_TOPIC_0059304227__b1653051661164049">true</strong>. If it is set to <strong id="EN-US_TOPIC_0059304227__b1776574786164051">false</strong>, automatic scheduling is disabled but manual scheduling is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row21014167"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p24425986">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p2931129">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p42130752164450">Scheduling period name</p>
<p id="EN-US_TOPIC_0059304227__p36094934">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_0059304227__row56418953"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p6532461">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p44024067">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p9179652">Operation type</p>
<p id="EN-US_TOPIC_0059304227__p15508011">Enumeration values: <strong id="EN-US_TOPIC_0059304227__b176371156132920">backup</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row5354379"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p31051517">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p53605320">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p47063664">Scheduling period parameters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row20919797"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p16782031">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p48373877">trigger_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p25969936">Scheduling policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row32402836"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p7384096">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.5.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p61563539">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.5.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p20590796">Scheduling period ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li25494973">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b62974848">operation_definition</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table28128170" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b4303191613338">operation_definition</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row9995691"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.6.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p17744544114718">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.6.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p1374416445472">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.6.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p17760204415477">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row32788649"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p38634918">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p13522398">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p1662615433283">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="EN-US_TOPIC_0059304227__b19987125062417">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304227__b1698745015246">0</strong> to <strong id="EN-US_TOPIC_0059304227__b1098865012241">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304227__b36311336122314">-1</strong>, backups will not be cleared by quantity limit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row59934386"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p22847115">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p45828933">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p762624392810">Duration of retaining a backup, in days. The value can be <strong id="EN-US_TOPIC_0059304227__b2594958192418">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304227__b185951758152414">0</strong> to <strong id="EN-US_TOPIC_0059304227__b459519580247">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304227__b156894273274">-1</strong>, backups will not be cleared by retention duration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row56187057"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p54857807">permanent</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p17238208">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p54117603">Whether backups are permanently retained</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row3396336335"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p11411933133315">plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p74143383318">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p241193320331">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row8465551103314"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p1646519515336">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.6.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p3465195117335">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.6.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p11465115133318">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_0059304227__b1335125812116">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li17296384">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b56369192">trigger_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table21449731" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b1510516181339">trigger_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row52707782"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.7.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p125258482474">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.7.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p16541124814713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.7.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p175411048174714">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row23976022"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p63009631">properties</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p15592812">trigger_properties_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p55058239">Scheduler properties</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row25762104"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p6355662">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p24900001">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p3634221">Scheduler ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row32707997"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p32102075">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p34099368">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p10585415">Scheduler name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row28159878"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p66357621">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.7.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p37152881">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.7.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p56593357">Scheduling type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li39578172">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b32538658">trigger_properties_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table20659230" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b6983219103312">trigger_properties_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row27765832"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.8.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p1830094912471">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.8.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p730017494479">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.8.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p1131594910479">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row21119259"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p32938458">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p18686714">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p10408666164546">Scheduling policy of the scheduler</p>
<p id="EN-US_TOPIC_0059304227__p37228842">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_0059304227__b385511552917">FREQ</strong>, <strong id="EN-US_TOPIC_0059304227__b1685513518298">BYDAY</strong>, <strong id="EN-US_TOPIC_0059304227__b1085516511293">BYHOUR</strong>, and <strong id="EN-US_TOPIC_0059304227__b1785515518294">BYMINUTE</strong>. <strong id="EN-US_TOPIC_0059304227__b1285595102915">FREQ</strong> can be set to <strong id="EN-US_TOPIC_0059304227__b118559510297">WEEKLY</strong> and <strong id="EN-US_TOPIC_0059304227__b1856451297">DAILY</strong>, <strong id="EN-US_TOPIC_0059304227__b9856105132914">BYDAY</strong> can be set to <strong id="EN-US_TOPIC_0059304227__b58561658292">MO</strong>, <strong id="EN-US_TOPIC_0059304227__b128564520295">TU</strong>, <strong id="EN-US_TOPIC_0059304227__b1085612512293">WE</strong>, <strong id="EN-US_TOPIC_0059304227__b685617502913">TH</strong>, <strong id="EN-US_TOPIC_0059304227__b108568572917">FR</strong>, <strong id="EN-US_TOPIC_0059304227__b1185613532911">SA</strong>, and <strong id="EN-US_TOPIC_0059304227__b585655142913">SU</strong> (seven days of a week), <strong id="EN-US_TOPIC_0059304227__b48579532912">BYHOUR</strong> ranges from 0 hours to 23 hours, and <strong id="EN-US_TOPIC_0059304227__b1385711572917">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_0059304227__row66624127"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p27845207">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p22079637">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p43620171">Start time of the scheduler, for example, 2017-03-07 09:31:08</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row1159494211512"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p959412428152">format</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.8.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p1859464217158">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.8.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p115944424156">Scheduler type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li62260646">Parameter description of field <strong id="EN-US_TOPIC_0059304227__b84235270695528">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table1431115645119" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304227__b127428218334">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304227__row4339106155119"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.9.2.2.4.1.1"><p id="EN-US_TOPIC_0059304227__p81901352194712">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.9.2.2.4.1.2"><p id="EN-US_TOPIC_0059304227__p3206952154720">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.9.2.2.4.1.3"><p id="EN-US_TOPIC_0059304227__p15221135214471">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row63768665110"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p10380567512">key</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p1739414617517">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0059304227__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304227__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304227__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row1116111556513"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.9.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304227__p1816118554511">value</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.9.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304227__p1116145519518">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.9.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304227__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0059304227__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304227__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304227__p83271213184417">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li57037220">Example response<pre class="screen" id="EN-US_TOPIC_0059304227__screen1877752218191">{
"policies" : [ {
"created_at" : "2017-03-07T09:31:08.265000",
"description" : "My plan",
"id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
"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",
"extra_info" : {
}
} ],
"scheduled_operations" : [ {
"description" : "My backup policy",
"enabled" : true,
"id" : "3b2fdf8c-2cc2-4887-9605-a8443922f6f2",
"name" : "my-backup-policy",
"operation_definition" : {
"max_backups" : "20",
"plan_id" : "27b11f3f-578d-4464-89d1-7c6d5894f753",
"provider_id" : "c714180d-ea34-4b13-9a5e-577c7c416eec"
},
"operation_type" : "backup",
"trigger" : {
"id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9",
"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:31:08",
"format": "ical"
},
"type" : "time"
},
"trigger_id" : "f1246246-ec6a-4e9a-917e-d050dc2808c9"
} ],
"status" : "disabled"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304227__section62130998"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304227__ul64336831"><li id="EN-US_TOPIC_0059304227__li42160567">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table43900785" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304227__row16295584"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304227__p44873929">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304227__p10909667">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row11267862"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p40281609">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p41584868">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304227__li38719496">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304227__table12931152" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304227__row6966727"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304227__p27434048">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304227__p7565421">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304227__row8819383"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p43281413">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p16133568">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row10984385"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p17320010">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p60743539">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row9820939"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p57298567">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p10672376">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row28942528"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p62643451">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p40954783">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row33048727"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p59701226">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p3961146">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304227__row35650316"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304227__p1994465">503</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304227__p27333991">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304227__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304227__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