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

554 lines
44 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304226"></a><a name="EN-US_TOPIC_0059304226"></a>
<h1 class="topictitle1">Querying a Backup Policy</h1>
<div id="body14442856"><div class="section" id="EN-US_TOPIC_0059304226__section64869004"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0059304226__p29020705">This API is used to query a backup policy by ID.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304226__section46950130"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304226__ul1866874"><li id="EN-US_TOPIC_0059304226__li16801866">URI format<p id="EN-US_TOPIC_0059304226__p16999067"><a name="EN-US_TOPIC_0059304226__li16801866"></a><a name="li16801866"></a>GET https://{endpoint}/v1/{project_id}/policies/{policy_id}</p>
</li><li id="EN-US_TOPIC_0059304226__li18773878">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table34747181" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row59205190"><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_0059304226__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_0059304226__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_0059304226__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_0059304226__p44729494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row46597571"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304226__p16306884">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_0059304226__p45789259">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_0059304226__p17942461">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_0059304226__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row60934955"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304226__p36784332">policy_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_0059304226__p26740917">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_0059304226__p18530703">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_0059304226__p24592002">Backup policy ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304226__section19897990"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304226__ul45795125"><li id="EN-US_TOPIC_0059304226__li9502942">Parameter description</li></ul>
<p id="EN-US_TOPIC_0059304226__p18417616">None</p>
<ul id="EN-US_TOPIC_0059304226__ul31540820"><li id="EN-US_TOPIC_0059304226__li15431932">Example request<pre class="screen" id="EN-US_TOPIC_0059304226__screen942415521811">GET https://{endpoint}/v1/{project_id}/policies/{policy_id}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304226__section44864185"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304226__ul42698471"><li id="EN-US_TOPIC_0059304226__li48741925">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table36024147" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row38832030"><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_0059304226__p17731724315">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_0059304226__p4926171432">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_0059304226__p2921017134314">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row5848912"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p3999858">policy</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_0059304226__p3504679">policy_resp</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_0059304226__p15443595">Query response</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li4774627">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b66904761">policy_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table42971646" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b16826165923115">policy_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row19193659"><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_0059304226__p1431162015431">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_0059304226__p1232792044318">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_0059304226__p3327102074313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row11457841"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p55669957">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_0059304226__p44153282">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_0059304226__p19646075">Creation time, for example, <strong id="EN-US_TOPIC_0059304226__b576361416218">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row42596951"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p27800986">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_0059304226__p377729">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_0059304226__p5382040916350">Backup policy description</p>
<p id="EN-US_TOPIC_0059304226__p30596085">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_0059304226__row6929316"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p24403744">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_0059304226__p58329702">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_0059304226__p27085440">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row42442371"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p15280018">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_0059304226__p58669387">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_0059304226__p4186901716351">Backup policy name</p>
<p id="EN-US_TOPIC_0059304226__p54599876">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_0059304226__row21636836"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p7753264">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_0059304226__p651535">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_0059304226__p52774385">Parameters of a backup policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row5207424"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p19148163">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_0059304226__p3310301">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_0059304226__p66807810">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row64399384"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p48967581">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_0059304226__p26168421">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_0059304226__p39267319">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_0059304226__b101718441745">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row17861557"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p37499989">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_0059304226__p16336415">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_0059304226__p48181273">Backup object list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row30978280"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p26212750">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_0059304226__p48944014">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_0059304226__p5042234">Scheduling period list</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row45380106"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p51909999">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_0059304226__p4023675">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_0059304226__p57482225">Backup policy status</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row697335312236"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p097325311231">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_0059304226__p11973353162317">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_0059304226__p16951038142">Tag list</p>
<p id="EN-US_TOPIC_0059304226__p0973053162317">Keys in the tag list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li47577981">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b18149865">policy_param</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table25548648" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b17741511183213">policy_param</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row64122593"><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_0059304226__p931182464312">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_0059304226__p13261124144316">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_0059304226__p1732682454313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row27161214"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p52574749">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_0059304226__p3370112">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_0059304226__p4543636">General backup policy parameters, which are blank by default</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li40892727">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b25704456">resource</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table32490229" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b174689135322">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row57020674"><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_0059304226__p1167132964314">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_0059304226__p068520296432">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_0059304226__p11685129104318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row39696990"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p61339649">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_0059304226__p64690095">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_0059304226__p5406347">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row48657127"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p48913182">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_0059304226__p4804387">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_0059304226__p2427141062110">Entity object type of backup objects</p>
<p id="EN-US_TOPIC_0059304226__p53611072">The value is fixed at <strong id="EN-US_TOPIC_0059304226__b1149145171617">OS::Nova::Server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row12737606"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p25113165">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_0059304226__p15217020">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_0059304226__p24619125">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row39813284499"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__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_0059304226__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_0059304226__p1677325193612">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li20245534">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b11257801">scheduled_operation_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table47992078" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b1091314614328">scheduled_operation_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row27160073"><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_0059304226__p121851442124320">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_0059304226__p132022042164312">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_0059304226__p13202204284313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row18334049"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p8662994">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_0059304226__p63805112">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_0059304226__p42177151163518">Scheduling period description</p>
<p id="EN-US_TOPIC_0059304226__p831615">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_0059304226__row7484535"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p2267583">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_0059304226__p46554464">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_0059304226__p530493163520">Whether the scheduling period is enabled</p>
<p id="EN-US_TOPIC_0059304226__p12815241">The default value is <strong id="EN-US_TOPIC_0059304226__b1267155877163142">true</strong>. If it is set to <strong id="EN-US_TOPIC_0059304226__b219270352163144">false</strong>, automatic scheduling is disabled but manual scheduling is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row48228313"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p14179266">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_0059304226__p17281810">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_0059304226__p60180051163527">Scheduling period name</p>
<p id="EN-US_TOPIC_0059304226__p57649352">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_0059304226__row49082128"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p16229428">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_0059304226__p46624455">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_0059304226__p18484485">Operation type</p>
<p id="EN-US_TOPIC_0059304226__p32142637">Enumeration values: <strong id="EN-US_TOPIC_0059304226__b12576143115291">backup</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row20848283"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p10989362">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_0059304226__p26286721">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_0059304226__p48849674">Scheduling period parameters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row36993883"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p43714507">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_0059304226__p54705592">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_0059304226__p1968006">Scheduling policy</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row17712059"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.5.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p25390687">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_0059304226__p24097279">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_0059304226__p5722572">Scheduling period ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li54796191">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b25383445">operation_definition</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table23403672" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b19732492323">operation_definition</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row43233365"><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_0059304226__p13271646154318">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_0059304226__p43416461439">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_0059304226__p12341174612436">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row61572465"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p21313750">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_0059304226__p51754458">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_0059304226__p1662615433283">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="EN-US_TOPIC_0059304226__b01531347165319">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304226__b6154947135315">0</strong> to <strong id="EN-US_TOPIC_0059304226__b015414717531">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304226__b1389103202014">-1</strong>, backups will not be cleared by quantity limit.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row13819033"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p45599851">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_0059304226__p9311222">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_0059304226__p762624392810">Duration of retaining a backup, in days. The value can be <strong id="EN-US_TOPIC_0059304226__b16964175111530">-1</strong> or ranges from <strong id="EN-US_TOPIC_0059304226__b2964185105311">0</strong> to <strong id="EN-US_TOPIC_0059304226__b19965155115535">99999</strong>. If the value is set to <strong id="EN-US_TOPIC_0059304226__b198205952010">-1</strong>, backups will not be cleared by retention duration.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row9885939"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p62563629">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_0059304226__p42163091">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_0059304226__p59767182">Whether backups are permanently retained</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row1112065753117"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p3120557143113">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_0059304226__p7121857103119">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_0059304226__p9121145713110">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row312210216335"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.6.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p1112282183319">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_0059304226__p212262133315">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_0059304226__p9122821334">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_0059304226__b121738341958">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li1033730">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b26948387">trigger_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table9303578" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b15229518322">trigger_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row47580858"><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_0059304226__p1065465034319">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_0059304226__p867115054318">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_0059304226__p1671150104320">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row54961897"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p22728661">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_0059304226__p6849025">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_0059304226__p17900178">Scheduler properties</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row26883882"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p30110853">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_0059304226__p55923996">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_0059304226__p33549865">Scheduler ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row33513332"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p30225352">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_0059304226__p1844030">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_0059304226__p15148719">Scheduler name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row2120750"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.7.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p37563094">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_0059304226__p27713086">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_0059304226__p30167503">Scheduling type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li3072075">Parameter description of field<strong id="EN-US_TOPIC_0059304226__b58091183"> trigger_properties_resp </strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table27648680" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b1111210536320">trigger_properties_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__row2508217"><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_0059304226__p13655125294317">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_0059304226__p176711052194319">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_0059304226__p9671175218434">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row35099287"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p24470004">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_0059304226__p23298284">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_0059304226__p9649851163558">Scheduling policy of the scheduler</p>
<p id="EN-US_TOPIC_0059304226__p8112855">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_0059304226__b158702517271">FREQ</strong>, <strong id="EN-US_TOPIC_0059304226__b1870115118279">BYDAY</strong>, <strong id="EN-US_TOPIC_0059304226__b1187011517278">BYHOUR</strong>, and <strong id="EN-US_TOPIC_0059304226__b5870145116279">BYMINUTE</strong>. <strong id="EN-US_TOPIC_0059304226__b1087019519274">FREQ</strong> can be set to <strong id="EN-US_TOPIC_0059304226__b2870951112710">WEEKLY</strong> and <strong id="EN-US_TOPIC_0059304226__b18870155112711">DAILY</strong>, <strong id="EN-US_TOPIC_0059304226__b68701051182714">BYDAY</strong> can be set to <strong id="EN-US_TOPIC_0059304226__b287017510278">MO</strong>, <strong id="EN-US_TOPIC_0059304226__b20870155114272">TU</strong>, <strong id="EN-US_TOPIC_0059304226__b48711451192716">WE</strong>, <strong id="EN-US_TOPIC_0059304226__b1687115515274">TH</strong>, <strong id="EN-US_TOPIC_0059304226__b587115114275">FR</strong>, <strong id="EN-US_TOPIC_0059304226__b1871351162713">SA</strong>, and <strong id="EN-US_TOPIC_0059304226__b487145122716">SU</strong> (seven days of a week), <strong id="EN-US_TOPIC_0059304226__b15871251162717">BYHOUR</strong> ranges from 0 hours to 23 hours, and <strong id="EN-US_TOPIC_0059304226__b17871145112276">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_0059304226__row5906832"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p8691401">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_0059304226__p48857155">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_0059304226__p65115477">Scheduler start time, for example, <strong id="EN-US_TOPIC_0059304226__b785111820216">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row3925102501419"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.8.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304226__p3927152511410">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_0059304226__p99279252143">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_0059304226__p1392742517147">Scheduler type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li62260646">Parameter description of field <strong id="EN-US_TOPIC_0059304226__b84235270695528">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table1431115645119" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304226__b17891175423218">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304226__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_0059304226__p69041455124319">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_0059304226__p129044555438">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_0059304226__p59041455144318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__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_0059304226__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_0059304226__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_0059304226__p13925135105714">Tag key</p>
<p id="EN-US_TOPIC_0059304226__p7327206587">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304226__p145821075819">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304226__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__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_0059304226__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_0059304226__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_0059304226__p1966153512589">Tag value</p>
<p id="EN-US_TOPIC_0059304226__p8808725135910">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304226__p919321595">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304226__p735402619438">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li49168383">Example response<pre class="screen" id="EN-US_TOPIC_0059304226__screen157033441813">{
"policy" : {
"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_0059304226__section1124484"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304226__ul29244399"><li id="EN-US_TOPIC_0059304226__li61873003">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table19986118" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304226__row50931523"><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_0059304226__p31812687">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_0059304226__p26690815">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row14472379"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p31412076">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_0059304226__p61350266">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304226__li15281487">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304226__table3315660" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304226__row29897299"><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_0059304226__p5762144">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_0059304226__p64080501">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304226__row23138107"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p62247385">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_0059304226__p8873464">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row12752320"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p26304962">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_0059304226__p50327193">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row50291560"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p47084569">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_0059304226__p55753746">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row32021674"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p43618787">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_0059304226__p43460857">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row55603394"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p7581037">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_0059304226__p10084265">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304226__row23649525"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304226__p36563340">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_0059304226__p8840584">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304226__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304226__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