yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
bf0249500a5ed7b17b83a0aff94fb5d48195ebc7
doc-exports/docs/cbr/api-ref/UpdatePolicy.html
tanweixi 56ef54c8ee cbr_api0219 version(worm) 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: tanweixi <tanweixi@huawei.com>
Co-committed-by: tanweixi <tanweixi@huawei.com>
2025-03-04 16:09:32 +00:00

635 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__section17135189124916"><h4 class="sectiontitle">Function</h4><p id="UpdatePolicy__p1213512912494">This API is used to modify a policy.</p>
</div>
<div class="section" id="UpdatePolicy__section161351994913"><h4 class="sectiontitle">URI</h4><p id="UpdatePolicy__p1313518954917">PUT /v3/{project_id}/policies/{policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__table1013617917491" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdatePolicy__row913515915492"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdatePolicy__p15136139144919">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdatePolicy__p51361497494">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdatePolicy__p713612911494">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdatePolicy__p61366912497">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row1613510912499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p1713613913493">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p113639174910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p5136499491">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p1613613919491">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row7135398496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p1013619920491">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p1713729134920">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p131371984914">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p91370918494">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section31371095498"><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__row16137159104915"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdatePolicy__p12138149104916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdatePolicy__p141381691495">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdatePolicy__p4138189124916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdatePolicy__p41382984918">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row11377915495"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdatePolicy__p15138109204914">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdatePolicy__p613829134918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdatePolicy__p1613812954912">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdatePolicy__p181385920492">User token</p>
<p id="UpdatePolicy__p513811994911">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="UpdatePolicy__b1113815914912">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__row113816964919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdatePolicy__p513911912492">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdatePolicy__p1013969184915">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdatePolicy__p16140149194918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdatePolicy__p81407916491">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row1138793491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdatePolicy__p161408916498">policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdatePolicy__p214009154918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdatePolicy__p181405913494"><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__p151407911497">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__row11140129124912"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpdatePolicy__p01418974914">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpdatePolicy__p171415944913">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpdatePolicy__p19141893498">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpdatePolicy__p18141119174917">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row41403924910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p6141109174915">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p1214110934917">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p8141169194910">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p151427910499">Whether to enable the policy</p>
<p id="UpdatePolicy__p2014259204915">Default: <strong id="UpdatePolicy__b1214249144911">true</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row31411934918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p314218910495">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p1514210913498">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p5142179144920">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p214249114914">Policy Name</p>
<p id="UpdatePolicy__p181422916491">Minimum: <strong id="UpdatePolicy__b114216904913">1</strong></p>
<p id="UpdatePolicy__p1014249154917">Maximum: <strong id="UpdatePolicy__b5142598494">64</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row16141139174911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p9142691492">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p111421496490">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p81421392499"><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__p1814215910491">Scheduling parameter</p>
</td>
</tr>
<tr id="UpdatePolicy__row151418954915"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p9142139194920">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p141431954912">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p121435954920"><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__p17143991498">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__row714359184919"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="UpdatePolicy__p81444954913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="UpdatePolicy__p1514418920492">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="UpdatePolicy__p17145394496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="UpdatePolicy__p81451792494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row21434910496"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p91451695497">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1814514910495">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1614579134910">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1314510994911">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__b1314519913494">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b914511954915">0</strong> to <strong id="UpdatePolicy__b2145897494">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b6145996492">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b21454914918">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p1514511918498">Minimum: <strong id="UpdatePolicy__b114539204917">0</strong></p>
<p id="UpdatePolicy__p8145159184911">Maximum: <strong id="UpdatePolicy__b11459954913">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row17143495499"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p161452910494">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p2145899494">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p141452091495">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p7145159134916">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row81431191494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p4146149174910">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p13146092496">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p101466911497">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p171462912498">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__row14143179124910"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p114639104920">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p51461197491">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1514617934918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1114618964912">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="UpdatePolicy__b161468954916">-1</strong> or ranges from <strong id="UpdatePolicy__b1814619204910">0</strong> to <strong id="UpdatePolicy__b1114711914498">99999</strong>. If the value is set to <strong id="UpdatePolicy__b51473934917">-1</strong>, backups will not be cleared by quantity limit. If this parameter and <strong id="UpdatePolicy__b191479964914">retention_duration_days</strong> are left blank at the same time, the backups will be retained permanently. This parameter and <strong id="UpdatePolicy__b81471295493">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p121471095492">Minimum: <strong id="UpdatePolicy__b1114769194914">1</strong></p>
<p id="UpdatePolicy__p51472912497">Maximum: <strong id="UpdatePolicy__b1814713917495">99999</strong></p>
<p id="UpdatePolicy__p19147995496">Default: <strong id="UpdatePolicy__b1147109124919">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row51443912493"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p514712914915">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p114719919498">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p21472920498">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1314709184913">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__b414789154910">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b3147597492">0</strong> to <strong id="UpdatePolicy__b614720918498">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b1514716920494">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b1714709194918">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p1714720994920">Minimum: <strong id="UpdatePolicy__b8147292499">0</strong></p>
<p id="UpdatePolicy__p151478984920">Maximum: <strong id="UpdatePolicy__b91471911497">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1414415944916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1914712984910">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p5147129144916">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p614749174916">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p11481399499">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b15148159104915">99999</strong>. If the value is set to <strong id="UpdatePolicy__b81482099492">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="UpdatePolicy__b7148139144910">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__b151481899498">max_backups</strong>, <strong id="UpdatePolicy__b7148179144917">day_backups</strong>, <strong id="UpdatePolicy__b51486924911">week_backups</strong>, <strong id="UpdatePolicy__b1914899134919">month_backups</strong>, and <strong id="UpdatePolicy__b20148494492">year_backups</strong>.</p>
<p id="UpdatePolicy__p41481797491">Minimum: <strong id="UpdatePolicy__b31483914910">1</strong></p>
<p id="UpdatePolicy__p9148169144913">Maximum: <strong id="UpdatePolicy__b01481198490">99999</strong></p>
<p id="UpdatePolicy__p1114819994915">Default: <strong id="UpdatePolicy__b91487914499">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row214414934916"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p171486904910">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1914811984918">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1214879134915">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1614889194914">Time zone where the user is located, for example, UTC+01:00. Set this parameter if you have configured any of the parameters: <strong id="UpdatePolicy__b01480994915">day_backups</strong>, <strong id="UpdatePolicy__b131486964920">week_backups</strong>, <strong id="UpdatePolicy__b14148393498">month_backups</strong>, <strong id="UpdatePolicy__b514839114914">year_backups</strong>.</p>
</td>
</tr>
<tr id="UpdatePolicy__row514419911491"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p8148199114911">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p8148594496">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p16149291498">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p414916984911">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__b8149159114910">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b11499920499">0</strong> to <strong id="UpdatePolicy__b13149892491">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b1114912964915">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b914913914490">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="UpdatePolicy__row514420904918"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p11493954912">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p314949174915">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p19149199104914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p214916911497">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__b131491695494">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b1115014934911">0</strong> to <strong id="UpdatePolicy__b1215089124911">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b815012918494">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b5150129204920">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p1615039124916">Minimum: <strong id="UpdatePolicy__b7150149144912">0</strong></p>
<p id="UpdatePolicy__p31506964920">Maximum: <strong id="UpdatePolicy__b141500914920">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__row1315099204911"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="UpdatePolicy__p51513964913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="UpdatePolicy__p10151119144918">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="UpdatePolicy__p1715114911498">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="UpdatePolicy__p91511295499">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row915013994914"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="UpdatePolicy__p815120914918">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="UpdatePolicy__p5151298493">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="UpdatePolicy__p10151189124913"><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__p131511904913">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__row5152898499"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="UpdatePolicy__p1015213910494">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="UpdatePolicy__p315289194912">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="UpdatePolicy__p51521994915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="UpdatePolicy__p151521499493">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row915216914911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="UpdatePolicy__p315211918498">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="UpdatePolicy__p415214918494">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="UpdatePolicy__p1815311994912">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="UpdatePolicy__p51531091499">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__b1515314915498">FREQ</strong>, <strong id="UpdatePolicy__b181531918492">BYDAY</strong>, <strong id="UpdatePolicy__b141537914491">BYHOUR</strong>, <strong id="UpdatePolicy__b41534964911">BYMINUTE</strong>, and <strong id="UpdatePolicy__b131530914913">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b515349174910">FREQ</strong> can be set only to <strong id="UpdatePolicy__b51531298491">WEEKLY</strong> or <strong id="UpdatePolicy__b1015389184914">DAILY</strong>. <strong id="UpdatePolicy__b21536914494">BYDAY</strong> can be set to <strong id="UpdatePolicy__b215310913496">MO</strong>, <strong id="UpdatePolicy__b1215399104915">TU</strong>, <strong id="UpdatePolicy__b181538912499">WE</strong>, <strong id="UpdatePolicy__b815312984916">TH</strong>, <strong id="UpdatePolicy__b215310924919">FR</strong>, <strong id="UpdatePolicy__b201535944919">SA</strong>, and <strong id="UpdatePolicy__b171535911494">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b115311918495">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b101534911494">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__b1415379144915">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__b101534917496">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section14153119124916"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdatePolicy__p11153496499"><strong id="UpdatePolicy__b7153396491">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__row715449184918"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdatePolicy__p15154119204916">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdatePolicy__p141544912495">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdatePolicy__p71551398497">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row141547914914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePolicy__p81552984916">policy</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePolicy__p151553984916"><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__p615599144919">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__row515579204915"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="UpdatePolicy__p131560910493">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="UpdatePolicy__p1015620944915">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="UpdatePolicy__p41566944920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row18155193499"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1015715914912">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p8157139114914">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p10157119164917">Whether the policy is enabled</p>
</td>
</tr>
<tr id="UpdatePolicy__row1115512964920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p12157109164912">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p201571912492">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p1115714914910">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row71551984913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1315739144910">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p14157296490">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p1815712912493">Policy Name</p>
</td>
</tr>
<tr id="UpdatePolicy__row3156129154918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1115710994914">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p11571894495"><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__p415720924918">Policy attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row141568964916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p181571592495">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p51586994920">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p11158179104911">Protection type, which can be <strong id="UpdatePolicy__b415849154910">backup</strong> or <strong id="UpdatePolicy__b5158149114917">replication</strong></p>
<p id="UpdatePolicy__p1315814920494">Enumeration values:</p>
<ul id="UpdatePolicy__ul18158129154920"><li id="UpdatePolicy__li415818912491"><strong id="UpdatePolicy__b2158189104914">backup</strong></li><li id="UpdatePolicy__li81589944918"><strong id="UpdatePolicy__b11580994911">replication</strong></li></ul>
</td>
</tr>
<tr id="UpdatePolicy__row4156590493"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1215811914491">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1815839144915"><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__p1415829174913">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="UpdatePolicy__row1915689154911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p2015859154910">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p71581096492">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__p915917918499">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__row31591919495"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdatePolicy__p4160119134910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdatePolicy__p1516017916499">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdatePolicy__p1416014964915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row14159189114915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p14160179194917">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p6160169114918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p11161295493">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__b6161497498">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b3161179194912">0</strong> to <strong id="UpdatePolicy__b121611954913">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b51611099497">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b181615913498">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p81611597492">Minimum: <strong id="UpdatePolicy__b316199134910">0</strong></p>
<p id="UpdatePolicy__p51612924912">Maximum: <strong id="UpdatePolicy__b14161159134910">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row515929144914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p11161394496">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p16161119104914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p10161199174915">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row201591496497"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1516139114918">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p2161179144919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p2161595494">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__row181592917493"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1464312974912">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1664314918495">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p064315920495">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="UpdatePolicy__b7643593495">-1</strong> or ranges from <strong id="UpdatePolicy__b10644491499">0</strong> to <strong id="UpdatePolicy__b76444912491">99999</strong>. If the value is set to <strong id="UpdatePolicy__b56441920492">-1</strong>, backups will not be cleared by quantity limit. If this parameter and <strong id="UpdatePolicy__b2644209174916">retention_duration_days</strong> are left blank at the same time, the backups will be retained permanently. This parameter and <strong id="UpdatePolicy__b186441496494">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p7644119204910">Minimum: <strong id="UpdatePolicy__b76446919492">1</strong></p>
<p id="UpdatePolicy__p564414934919">Maximum: <strong id="UpdatePolicy__b18644898498">99999</strong></p>
<p id="UpdatePolicy__p136442924916">Default: <strong id="UpdatePolicy__b186442994919">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row815969194911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1364414917499">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p186440904920">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p86444934913">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__b1264479144911">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b1664449154920">0</strong> to <strong id="UpdatePolicy__b176441964910">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b1064417911495">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b1064410954914">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p196448920497">Minimum: <strong id="UpdatePolicy__b9644149174916">0</strong></p>
<p id="UpdatePolicy__p156443913494">Maximum: <strong id="UpdatePolicy__b464416994913">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row51599913492"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p176446964919">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p116447913494">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p664410984918">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b964412915497">99999</strong>. If the value is set to <strong id="UpdatePolicy__b10644119154912">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="UpdatePolicy__b364412912494">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__b1664410984919">max_backups</strong>, <strong id="UpdatePolicy__b864412913497">day_backups</strong>, <strong id="UpdatePolicy__b1164413984918">week_backups</strong>, <strong id="UpdatePolicy__b364416944918">month_backups</strong>, and <strong id="UpdatePolicy__b136448924917">year_backups</strong>.</p>
<p id="UpdatePolicy__p126446954916">Minimum: <strong id="UpdatePolicy__b1664410916494">1</strong></p>
<p id="UpdatePolicy__p664419919490">Maximum: <strong id="UpdatePolicy__b156451954912">99999</strong></p>
<p id="UpdatePolicy__p1464513914493">Default: <strong id="UpdatePolicy__b964514911499">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row01591954919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p36459911497">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1164518914916">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p26458924914">Time zone where the user is located, for example, UTC+01:00. Set this parameter if you have configured any of the parameters: <strong id="UpdatePolicy__b146457924914">day_backups</strong>, <strong id="UpdatePolicy__b10645798492">week_backups</strong>, <strong id="UpdatePolicy__b4645179124910">month_backups</strong>, <strong id="UpdatePolicy__b16451964914">year_backups</strong>.</p>
</td>
</tr>
<tr id="UpdatePolicy__row31593924917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1464518914912">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p56459984913">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p20645791498">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__b1864518964917">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b20645119174919">0</strong> to <strong id="UpdatePolicy__b1264512920491">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b186452918490">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b166458984918">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="UpdatePolicy__row15160796495"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p6645179174912">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1564517916491">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p15645159174913">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__b964517913493">max_backups</strong> will both be applied. The value ranges from <strong id="UpdatePolicy__b1664514954913">0</strong> to <strong id="UpdatePolicy__b156451793494">100</strong>. If this parameter is configured, <strong id="UpdatePolicy__b2645791499">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b1864517913498">retention_duration_days</strong> cannot be both applied.</p>
<p id="UpdatePolicy__p864559174917">Minimum: <strong id="UpdatePolicy__b66451899492">0</strong></p>
<p id="UpdatePolicy__p196457964919">Maximum: <strong id="UpdatePolicy__b1264515916496">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__row8168898495"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="UpdatePolicy__p264511924912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="UpdatePolicy__p1645199204911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="UpdatePolicy__p166463954919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row111681918490"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p464619918499">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p1564669204912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p11646129194911">Scheduler ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row17172159204916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p66461924912">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p66461914912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p1064612916498">Scheduler name</p>
</td>
</tr>
<tr id="UpdatePolicy__row1917212916494"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p156463912499">properties</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p10646996495"><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__p3646179114916">Scheduler attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row41729920497"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p13646598492">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p46466914915">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p364616924918">Scheduler type. Currently, only <strong id="UpdatePolicy__b4646493493">time</strong> (periodic scheduling) is supported.</p>
<p id="UpdatePolicy__p1464611974919">Enumeration values:</p>
<ul id="UpdatePolicy__ul1064699114919"><li id="UpdatePolicy__li1064614912497"><strong id="UpdatePolicy__b2646169174910">time</strong></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__row217510924913"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdatePolicy__p0646129194913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdatePolicy__p106462918491">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdatePolicy__p1064619911495">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row21765964915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p26461996498">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p56461091498">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p166461290496">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__b764612911490">FREQ</strong>, <strong id="UpdatePolicy__b1664716924911">BYDAY</strong>, <strong id="UpdatePolicy__b16647693492">BYHOUR</strong>, <strong id="UpdatePolicy__b1664714994919">BYMINUTE</strong>, and <strong id="UpdatePolicy__b7647697494">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b106473944919">FREQ</strong> can be set only to <strong id="UpdatePolicy__b7647149154918">WEEKLY</strong> or <strong id="UpdatePolicy__b1364716917499">DAILY</strong>. <strong id="UpdatePolicy__b56472094494">BYDAY</strong> can be set to <strong id="UpdatePolicy__b1964719134920">MO</strong>, <strong id="UpdatePolicy__b1964713912497">TU</strong>, <strong id="UpdatePolicy__b96471496497">WE</strong>, <strong id="UpdatePolicy__b7647298490">TH</strong>, <strong id="UpdatePolicy__b1264729144918">FR</strong>, <strong id="UpdatePolicy__b1564719964910">SA</strong>, and <strong id="UpdatePolicy__b8647096495">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b11647139194913">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b96479964919">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__b2647129184913">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__b15647159144919">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row41767964914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p264715944917">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p18647129124919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p36471097496">Start time of the scheduler, for example, <strong id="UpdatePolicy__b136478914496">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__row817889154918"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="UpdatePolicy__p76471498499">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="UpdatePolicy__p6647095495">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="UpdatePolicy__p1764716916499">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row11781491491"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p1064713964918">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p16647790491">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p264718920490">ID of the associated remote vault</p>
</td>
</tr>
<tr id="UpdatePolicy__row517817914911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p5647199104914">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p26479918496">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p196477917495">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section164719934915"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="UpdatePolicy__screen96472934919">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__section196486912499"><h4 class="sectiontitle">Example Responses</h4><p id="UpdatePolicy__p464859164911"><strong id="UpdatePolicy__b964813974916">Status code: 200</strong></p>
<p id="UpdatePolicy__p1764820984912">OK</p>
<pre class="screen" id="UpdatePolicy__screen1564849154915">{
"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__section196487913495"><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__row151845911497"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdatePolicy__p3649994493">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__p13649159184919">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row218411964911"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePolicy__p5649791493">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePolicy__p964949134919">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section1264929144915"><h4 class="sectiontitle">Error Codes</h4><p id="UpdatePolicy__p4649697491">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