yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
8ca8e2b2cf6ceacba7682e0334513a367a2b1e5a
doc-exports/docs/cbr/api-ref/UpdatePolicy.html
weihongmin1 5d7ef90c79 CBR API 0329 Version 
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: weihongmin1 <weihongmin1@huawei.com>
Co-committed-by: weihongmin1 <weihongmin1@huawei.com>
2025-04-15 08:17:11 +00:00

638 lines
54 KiB
HTML
Raw Blame History

<a name="UpdatePolicy"></a><a name="UpdatePolicy"></a>
<h1 class="topictitle1">Modifying a Policy</h1>
<div id="body1708331107508"><div class="section" id="UpdatePolicy__section8297458192419"><h4 class="sectiontitle">Function</h4><p id="UpdatePolicy__p1529785818242">This API is used to modify a policy.</p>
</div>
<div class="section" id="UpdatePolicy__section102981558162417"><h4 class="sectiontitle">URI</h4><p id="UpdatePolicy__p7298158122415">PUT /v3/{project_id}/policies/{policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__table1229975882412" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdatePolicy__row15298135842419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdatePolicy__p142991458192410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdatePolicy__p17299155852412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdatePolicy__p18299165811247">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdatePolicy__p1529985817241">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row1629825832417"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p19299105852414">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p429945852416">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p1729911583245">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p1429995872415">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row52989586243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p10299205819247">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p929935872418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p1300115813249">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p1630055814247">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section63002584246"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="UpdatePolicy__row133001058152418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdatePolicy__p7300358172420">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdatePolicy__p1330110583242">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdatePolicy__p17301135812249">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdatePolicy__p73012058172413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row4300185814247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdatePolicy__p17301115810241">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdatePolicy__p14301105810244">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdatePolicy__p730125814246">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdatePolicy__p2301145817240">User token</p>
<p id="UpdatePolicy__p183011258202415">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="UpdatePolicy__b93010582243">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__request_PolicyUpdateReq" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="UpdatePolicy__row43029583246"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdatePolicy__p6302958162411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdatePolicy__p11302155818241">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdatePolicy__p1130212587241">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdatePolicy__p143035589240">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row10302758122414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdatePolicy__p18303155842418">policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdatePolicy__p133031558102413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdatePolicy__p7303185862413"><a href="#UpdatePolicy__request_PolicyUpdate">PolicyUpdate</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdatePolicy__p16303258172410">Request body of modifying a policy</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__request_PolicyUpdate"></a><a name="request_PolicyUpdate"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__request_PolicyUpdate" frame="border" border="1" rules="all"><caption><b>Table 4 </b>PolicyUpdate</caption><thead align="left"><tr id="UpdatePolicy__row7305165852415"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpdatePolicy__p16306165813244">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpdatePolicy__p10306135817246">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpdatePolicy__p13306658102420">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpdatePolicy__p730605813242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row43056581249"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p17306135822412">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p19307135811245">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p730765815241">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p1830710588248">Whether to enable the policy</p>
<p id="UpdatePolicy__p73078583248">Default: <strong id="UpdatePolicy__b430717585244">true</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row630515584247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p15307558162410">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p230765819249">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p4307658122410">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p53071758192411">Policy Name</p>
<p id="UpdatePolicy__p9307358132419">Minimum: <strong id="UpdatePolicy__b103074587247">1</strong></p>
<p id="UpdatePolicy__p143071058172414">Maximum: <strong id="UpdatePolicy__b6307125817244">64</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row03056588246"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p630711585240">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p17308105872411">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p330812589240"><a href="#UpdatePolicy__request_PolicyoODCreate">PolicyoODCreate</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p1308358172415">Scheduling parameter</p>
</td>
</tr>
<tr id="UpdatePolicy__row630605819246"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p330815816248">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p14308155819246">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p143081558162410"><a href="#UpdatePolicy__request_PolicyTriggerReq">PolicyTriggerReq</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p123081558162411">Time rule for the policy execution</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__request_PolicyoODCreate"></a><a name="request_PolicyoODCreate"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__request_PolicyoODCreate" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PolicyoODCreate</caption><thead align="left"><tr id="UpdatePolicy__row830925816245"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="UpdatePolicy__p7310195812248">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="UpdatePolicy__p7310958102412">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="UpdatePolicy__p1431075832416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="UpdatePolicy__p143101658112412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row20309145842418"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p8310145816245">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1831085810244">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1031015589242">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p8310658122418">Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and <strong id="UpdatePolicy__b1631035832416">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b2310358112414">0</strong> to <strong id="UpdatePolicy__b193102058112412">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b14310458132420">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b19310165813248">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p831095815247">Minimum: <strong id="UpdatePolicy__b7310185815243">0</strong></p>
<p id="UpdatePolicy__p133101758162411">Maximum: <strong id="UpdatePolicy__b531019585247">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row203091158142412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p531017582242">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p431005815242">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1131165818242">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p23117582240">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row6309185862414"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p193111958182415">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p9311458172418">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1311958182413">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p183111658162413">Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="UpdatePolicy__row130965811243"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p93111458172417">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p831175872414">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p17311558172412">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p13120580241">Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.</p>
<p id="UpdatePolicy__p15312758122419">Minimum: <strong id="UpdatePolicy__b53121158102410">1</strong></p>
<p id="UpdatePolicy__p1831212581240">Maximum: <strong id="UpdatePolicy__b18312155819242">99999</strong></p>
<p id="UpdatePolicy__p1131215882417">Default: <strong id="UpdatePolicy__b15312175812244">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1230925815247"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p6312458192418">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p123121158162413">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p11312145815241">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p6312158102416">Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and <strong id="UpdatePolicy__b03121058182413">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b9312125832414">0</strong> to <strong id="UpdatePolicy__b93121258192410">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b331211581245">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b15312165892417">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p331275819248">Minimum: <strong id="UpdatePolicy__b131216589241">0</strong></p>
<p id="UpdatePolicy__p731214583243">Maximum: <strong id="UpdatePolicy__b7312858122410">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row230965872419"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p6312058112419">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p19312258102415">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p531320581243">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p0313155816247">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b131395810246">99999</strong>. If the value is set to <strong id="UpdatePolicy__b193134583244">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="UpdatePolicy__b12313115816241">max_backups</strong> are left blank at the same time, the backups will be retained permanently. This parameter cannot be applied together with <strong id="UpdatePolicy__b1031311580241">max_backups</strong>, <strong id="UpdatePolicy__b631314582241">day_backups</strong>, <strong id="UpdatePolicy__b731319589245">week_backups</strong>, <strong id="UpdatePolicy__b2313145817244">month_backups</strong>, and <strong id="UpdatePolicy__b19313115819243">year_backups</strong>.</p>
<p id="UpdatePolicy__p1831385816243">Minimum: <strong id="UpdatePolicy__b203135587242">1</strong></p>
<p id="UpdatePolicy__p183131358152414">Maximum: <strong id="UpdatePolicy__b17313195802410">99999</strong></p>
<p id="UpdatePolicy__p1931314582243">Default: <strong id="UpdatePolicy__b33131358152412">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row18309185814242"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p7313205810241">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p6313175892418">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1231385814249">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1731355814248">Time zone where the user is located. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.</p>
</td>
</tr>
<tr id="UpdatePolicy__row1930911583241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1731345817247">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p131365852415">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p113131158132413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p12314155852417">Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and <strong id="UpdatePolicy__b33141858172413">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b163141458122416">0</strong> to <strong id="UpdatePolicy__b1931405814243">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b73142058172417">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b183144586241">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="UpdatePolicy__row4309558172416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1831495862416">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1931485813243">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p73147582241">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p331485862412">Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and <strong id="UpdatePolicy__b2031435815247">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b17314105892411">0</strong> to <strong id="UpdatePolicy__b113142588249">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b431416583243">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b10314205820242">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p531412583243">Minimum: <strong id="UpdatePolicy__b03141558192420">0</strong></p>
<p id="UpdatePolicy__p431455862410">Maximum: <strong id="UpdatePolicy__b1231445816249">100</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__request_PolicyTriggerReq"></a><a name="request_PolicyTriggerReq"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__request_PolicyTriggerReq" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PolicyTriggerReq</caption><thead align="left"><tr id="UpdatePolicy__row7315158162413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="UpdatePolicy__p63151158102410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="UpdatePolicy__p15315175813247">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="UpdatePolicy__p131555802414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="UpdatePolicy__p153151585242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row10315185814246"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="UpdatePolicy__p431515812419">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="UpdatePolicy__p183151258182414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="UpdatePolicy__p143158586245"><a href="#UpdatePolicy__request_PolicyTriggerPropertiesReq">PolicyTriggerPropertiesReq</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="UpdatePolicy__p93165582246">Scheduler attributes</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__request_PolicyTriggerPropertiesReq"></a><a name="request_PolicyTriggerPropertiesReq"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__request_PolicyTriggerPropertiesReq" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PolicyTriggerPropertiesReq</caption><thead align="left"><tr id="UpdatePolicy__row123161358132410"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="UpdatePolicy__p143161858122414">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="UpdatePolicy__p13164580246">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="UpdatePolicy__p16316115842418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="UpdatePolicy__p531755842413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row33161458112411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="UpdatePolicy__p153177582245">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="UpdatePolicy__p33171458172412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="UpdatePolicy__p8317185817245">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="UpdatePolicy__p23171858182414">Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the <strong id="UpdatePolicy__b9317165882417">FREQ</strong>, <strong id="UpdatePolicy__b3317175819249">BYDAY</strong>, <strong id="UpdatePolicy__b231745816246">BYHOUR</strong>, <strong id="UpdatePolicy__b1131713583243">BYMINUTE</strong>, and <strong id="UpdatePolicy__b731712581245">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b2031735812245">FREQ</strong> can be set only to <strong id="UpdatePolicy__b1931705812413">WEEKLY</strong> or <strong id="UpdatePolicy__b1231715819246">DAILY</strong>. <strong id="UpdatePolicy__b14317758112410">BYDAY</strong> can be set to <strong id="UpdatePolicy__b14317155818241">MO</strong>, <strong id="UpdatePolicy__b9317195832415">TU</strong>, <strong id="UpdatePolicy__b173171458152412">WE</strong>, <strong id="UpdatePolicy__b83174587248">TH</strong>, <strong id="UpdatePolicy__b83171058142414">FR</strong>, <strong id="UpdatePolicy__b831712589242">SA</strong>, and <strong id="UpdatePolicy__b1031735812418">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b1231715589247">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b231713585240">BYMINUTE</strong> ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: <strong id="UpdatePolicy__b7317145872416">FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00</strong>. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: <strong id="UpdatePolicy__b83171558182410">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section6317658142416"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdatePolicy__p8318658132415"><strong id="UpdatePolicy__b8318158192415">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_PolicyCreateResp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="UpdatePolicy__row1431875832419"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdatePolicy__p431865812412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdatePolicy__p3318145815243">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdatePolicy__p16318175819241">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row031817584243"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePolicy__p14318165852415">policy</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePolicy__p1031955892418"><a href="#UpdatePolicy__response_Policy">Policy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePolicy__p12319155812417">Response to the request for creating a policy</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__response_Policy"></a><a name="response_Policy"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_Policy" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Policy</caption><thead align="left"><tr id="UpdatePolicy__row16319135892410"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="UpdatePolicy__p1732065852415">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="UpdatePolicy__p13320195811249">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="UpdatePolicy__p8320758102416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row23191958162413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p6320358102415">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1232095812247">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p17320105818242">Whether the policy is enabled</p>
</td>
</tr>
<tr id="UpdatePolicy__row731913585246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p63201958102417">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p33201658182416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p43201058172418">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row331915589249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p18320115810245">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p5321658202415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p1832115813240">Policy Name</p>
</td>
</tr>
<tr id="UpdatePolicy__row531912582244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1932115815246">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p3321195817241"><a href="#UpdatePolicy__response_PolicyoODCreate">PolicyoODCreate</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p14321205819245">Policy attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row63191058162420"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p83217588241">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p13211158172415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p7321858142417">Protection type, which can be <strong id="UpdatePolicy__b0321175852410">backup</strong> or <strong id="UpdatePolicy__b10321165811245">replication</strong></p>
<p id="UpdatePolicy__p20321758162411">Enumeration values:</p>
<ul id="UpdatePolicy__ul1232111581244"><li id="UpdatePolicy__li53211658112414"><p id="UpdatePolicy__p1432175872417"><a name="UpdatePolicy__li53211658112414"></a><a name="li53211658112414"></a><strong id="UpdatePolicy__b163221758112410">backup</strong></p>
</li><li id="UpdatePolicy__li1732255817247"><p id="UpdatePolicy__p1632215832415"><a name="UpdatePolicy__li1732255817247"></a><a name="li1732255817247"></a><strong id="UpdatePolicy__b133221858182414">replication</strong></p>
</li></ul>
</td>
</tr>
<tr id="UpdatePolicy__row1331945862415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p18322155852415">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p43226589243"><a href="#UpdatePolicy__response_PolicyTriggerResp">PolicyTriggerResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p2322958152412">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="UpdatePolicy__row1931917583248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p193221458112419">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1632210583243">Array of <a href="#UpdatePolicy__response_PolicyAssociateVault">PolicyAssociateVault</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p7322165818244">Associated vault</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__response_PolicyoODCreate"></a><a name="response_PolicyoODCreate"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_PolicyoODCreate" frame="border" border="1" rules="all"><caption><b>Table 10 </b>PolicyoODCreate</caption><thead align="left"><tr id="UpdatePolicy__row5323135815248"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdatePolicy__p1732575811241">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdatePolicy__p163261858122415">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdatePolicy__p10326258182416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row9323145812417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p17326158162413">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p43261558112412">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p123266584248">Maximum number of daily backups that can be retained. The latest backup of each day is saved in the long term. This parameter and <strong id="UpdatePolicy__b8326145811247">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b23264582242">0</strong> to <strong id="UpdatePolicy__b232625815242">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b2326958152418">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b19326145842416">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p163263584242">Minimum: <strong id="UpdatePolicy__b1232625812411">0</strong></p>
<p id="UpdatePolicy__p33264585246">Maximum: <strong id="UpdatePolicy__b232675814245">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row9323258142415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p632617582243">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1032605812247">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p532625822417">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row032310587248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p732675811243">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1032613586244">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p10327115882419">Replication destination region, which is mandatory for cross-region replication. The destination region cannot be the same as the current region. The value contains 0 to 255 characters, including only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="UpdatePolicy__row1323125813246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p2071975820241">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1671919588248">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p1671955819241">Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.</p>
<p id="UpdatePolicy__p127191258182417">Minimum: <strong id="UpdatePolicy__b177193581242">1</strong></p>
<p id="UpdatePolicy__p4719145822415">Maximum: <strong id="UpdatePolicy__b5719155812246">99999</strong></p>
<p id="UpdatePolicy__p5719175811244">Default: <strong id="UpdatePolicy__b8719758202411">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1032314585245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p117191158152418">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p9719458182413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p13719125842414">Maximum number of monthly backups that can be retained. The latest backup of each month is saved in the long term. This parameter and <strong id="UpdatePolicy__b2071911584243">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b1271935818242">0</strong> to <strong id="UpdatePolicy__b4719155813246">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b9719858152420">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b177191058142415">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p14719135819245">Minimum: <strong id="UpdatePolicy__b17191158102417">0</strong></p>
<p id="UpdatePolicy__p1071945822420">Maximum: <strong id="UpdatePolicy__b1271965822411">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row832385813245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p197192588244">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p8719135862415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p2719105882418">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b871925817244">99999</strong>. If the value is set to <strong id="UpdatePolicy__b9719185819241">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="UpdatePolicy__b8719358122417">max_backups</strong> are left blank at the same time, the backups will be retained permanently. This parameter cannot be applied together with <strong id="UpdatePolicy__b107191580246">max_backups</strong>, <strong id="UpdatePolicy__b6719115872419">day_backups</strong>, <strong id="UpdatePolicy__b12719115812417">week_backups</strong>, <strong id="UpdatePolicy__b11719195862419">month_backups</strong>, and <strong id="UpdatePolicy__b13719175812246">year_backups</strong>.</p>
<p id="UpdatePolicy__p19719165842413">Minimum: <strong id="UpdatePolicy__b271915816242">1</strong></p>
<p id="UpdatePolicy__p14719558132417">Maximum: <strong id="UpdatePolicy__b671955842420">99999</strong></p>
<p id="UpdatePolicy__p371955892415">Default: <strong id="UpdatePolicy__b1871914582241">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row19323058122416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p20719358102410">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p14719115812412">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p187193580248">Time zone where the user is located. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.</p>
</td>
</tr>
<tr id="UpdatePolicy__row232335816241"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p177191958152415">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p8719358202419">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p167199586246">Maximum number of weekly backups that can be retained. The latest backup of each week is saved in the long term. This parameter and <strong id="UpdatePolicy__b167197583246">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b5719175872415">0</strong> to <strong id="UpdatePolicy__b207196585245">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b271919586243">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b6719155822420">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="UpdatePolicy__row203232058132410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p177191758182415">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1571905813244">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p1471935811241">Maximum number of yearly backups that can be retained. The latest backup of each year is saved in the long term. This parameter and <strong id="UpdatePolicy__b107191158182417">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b7719115810240">0</strong> to <strong id="UpdatePolicy__b571910587246">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b1571995813247">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b14719658122420">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p4719145842419">Minimum: <strong id="UpdatePolicy__b177199588244">0</strong></p>
<p id="UpdatePolicy__p3719175813245">Maximum: <strong id="UpdatePolicy__b07191658172420">100</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__response_PolicyTriggerResp"></a><a name="response_PolicyTriggerResp"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_PolicyTriggerResp" frame="border" border="1" rules="all"><caption><b>Table 11 </b>PolicyTriggerResp</caption><thead align="left"><tr id="UpdatePolicy__row7330195819246"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="UpdatePolicy__p15720185812416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="UpdatePolicy__p197201258192411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="UpdatePolicy__p67201758172414">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row123301758192415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p2720205810240">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p2072025819242">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p1672035811243">Scheduler ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row19330115802416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p107207584248">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p6720858142413">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p3720175814245">Scheduler name</p>
</td>
</tr>
<tr id="UpdatePolicy__row1433095822416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p27201758132413">properties</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p8720458182420"><a href="#UpdatePolicy__response_PolicyTriggerPropertiesResp">PolicyTriggerPropertiesResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p372035815243">Scheduler attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row33306586245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p20720858192412">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p177201458192415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p1472065872415">Scheduler type. Currently, only <strong id="UpdatePolicy__b872085842419">time</strong> (periodic scheduling) is supported.</p>
<p id="UpdatePolicy__p072011583245">Enumeration values:</p>
<ul id="UpdatePolicy__ul2072095814242"><li id="UpdatePolicy__li77201658162412"><p id="UpdatePolicy__p1572025862412"><a name="UpdatePolicy__li77201658162412"></a><a name="li77201658162412"></a><strong id="UpdatePolicy__b16720185815244">time</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__response_PolicyTriggerPropertiesResp"></a><a name="response_PolicyTriggerPropertiesResp"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_PolicyTriggerPropertiesResp" frame="border" border="1" rules="all"><caption><b>Table 12 </b>PolicyTriggerPropertiesResp</caption><thead align="left"><tr id="UpdatePolicy__row93311658152411"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdatePolicy__p572095842418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdatePolicy__p18720175813245">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdatePolicy__p1272016585248">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row16332165812419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p87207587245">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p1572055852420">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p19721158102416">Scheduling rule of the scheduler. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only the <strong id="UpdatePolicy__b3721175817240">FREQ</strong>, <strong id="UpdatePolicy__b472135842411">BYDAY</strong>, <strong id="UpdatePolicy__b19721115813249">BYHOUR</strong>, <strong id="UpdatePolicy__b9721858112418">BYMINUTE</strong>, and <strong id="UpdatePolicy__b072113581245">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b87211958182418">FREQ</strong> can be set only to <strong id="UpdatePolicy__b5721145810241">WEEKLY</strong> or <strong id="UpdatePolicy__b672175811249">DAILY</strong>. <strong id="UpdatePolicy__b8721175852416">BYDAY</strong> can be set to <strong id="UpdatePolicy__b127219582244">MO</strong>, <strong id="UpdatePolicy__b137211158122411">TU</strong>, <strong id="UpdatePolicy__b127215588246">WE</strong>, <strong id="UpdatePolicy__b1721125811245">TH</strong>, <strong id="UpdatePolicy__b127211258182411">FR</strong>, <strong id="UpdatePolicy__b177219582243">SA</strong>, and <strong id="UpdatePolicy__b67211358132412">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b6721758112416">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b272145820249">BYMINUTE</strong> ranges from 0 to 59 minutes. The scheduling interval cannot be less than 1 hour. A maximum of 24 time points are allowed in a day. For example, if the scheduling time is 14:00 (UTC) from Monday to Sunday, set the scheduling rule as follows: <strong id="UpdatePolicy__b072119585244">FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00</strong>. If the scheduling time is 14:00 (UTC+8) every day, set the scheduling rule as follows: <strong id="UpdatePolicy__b97211158122410">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row43321589246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p97211658112412">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p167217589247">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p14721175814247">Start time of the scheduler, for example, <strong id="UpdatePolicy__b1721258172419">2020-01-08 09:59:49</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="UpdatePolicy__response_PolicyAssociateVault"></a><a name="response_PolicyAssociateVault"></a><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__response_PolicyAssociateVault" frame="border" border="1" rules="all"><caption><b>Table 13 </b>PolicyAssociateVault</caption><thead align="left"><tr id="UpdatePolicy__row03333588247"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="UpdatePolicy__p772135832419">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="UpdatePolicy__p15721115852417">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="UpdatePolicy__p20721258152413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row19333125810246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p672145812241">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p572185817247">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p272111583247">ID of the associated remote vault</p>
</td>
</tr>
<tr id="UpdatePolicy__row113336589242"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p1772195818243">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p27211858172414">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p2721135813249">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section27211858162413"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="UpdatePolicy__screen17211586247">PUT https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/policies/cbb3ce6f-3332-4e7c-b98e-77290d8471ff
{
"policy" : {
"enabled" : true,
"name" : "policy001",
"operation_definition" : {
"day_backups" : 0,
"month_backups" : 0,
"max_backups" : 1,
"timezone" : "UTC+01:00",
"week_backups" : 0,
"year_backups" : 0
},
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ]
}
}
}
}</pre>
</div>
<div class="section" id="UpdatePolicy__section8721175862413"><h4 class="sectiontitle">Example Responses</h4><p id="UpdatePolicy__p47211158132415"><strong id="UpdatePolicy__b167211858172415">Status code: 200</strong></p>
<p id="UpdatePolicy__p16721658112416">OK</p>
<pre class="screen" id="UpdatePolicy__screen18721158202412">{
"policy" : {
"name" : "policy001",
"associated_vaults" : [ ],
"enabled" : true,
"trigger" : {
"properties" : {
"pattern" : [ "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00" ],
"start_time" : "2019-05-08T06:57:05.000+00:00"
},
"type" : "time",
"id" : "d67269a6-5369-42d7-8150-5254bd446328",
"name" : "default"
},
"operation_definition" : {
"max_backups" : 1,
"year_backups" : 0,
"day_backups" : 0,
"month_backups" : 0,
"week_backups" : 0,
"timezone" : "UTC+01:00"
},
"operation_type" : "backup",
"id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
}
}</pre>
</div>
<div class="section" id="UpdatePolicy__section17722185842419"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdatePolicy__row103352058102418"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdatePolicy__p137224584249">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="UpdatePolicy__p127221558192411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row183351058142416"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePolicy__p17220582245">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePolicy__p15722185817246">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section207221858152412"><h4 class="sectiontitle">Error Codes</h4><p id="UpdatePolicy__p167224588245">See <a href="ErrorCode.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Policies</a></div>
</div>
</div>
View Git Blame Copy Permalink