vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cbr/api-ref/UpdatePolicy.html
Zaoxu, Li e98ae60365 cbr_api0124 Added CBR actions 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-09-12 08:27:22 +00:00

634 lines
53 KiB
HTML
Raw Blame History

<a name="UpdatePolicy"></a><a name="UpdatePolicy"></a>
<h1 class="topictitle1">Modifying a Policy</h1>
<div id="body14108191314362"><div class="section" id="UpdatePolicy__section21081413183613"><h4 class="sectiontitle">Function</h4><p id="UpdatePolicy__p17108813103617">This API is used to modify a policy.</p>
</div>
<div class="section" id="UpdatePolicy__section610818138367"><h4 class="sectiontitle">URI</h4><p id="UpdatePolicy__p410981316369">PUT /v3/{project_id}/policies/{policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdatePolicy__table5109111310362" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdatePolicy__row710941316363"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="UpdatePolicy__p12109313113619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="UpdatePolicy__p311041363614">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="UpdatePolicy__p21105134367">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="UpdatePolicy__p21101613153612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row010919135362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p11110171303614">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p8110151316367">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p14110121316367">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p4110141319364">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row12109121313362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="UpdatePolicy__p17110191303612">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="UpdatePolicy__p18110161312366">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="UpdatePolicy__p611081311368">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="UpdatePolicy__p13110131343611">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section10110201312361"><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__row2111213113610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="UpdatePolicy__p18111613193614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="UpdatePolicy__p111111303613">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="UpdatePolicy__p151119132364">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="UpdatePolicy__p1511111343616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row17111181323617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="UpdatePolicy__p16111151314362">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="UpdatePolicy__p1311171311360">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="UpdatePolicy__p0111121319363">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="UpdatePolicy__p1311151313620">User token The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="UpdatePolicy__b11111713193617">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__row81123137361"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdatePolicy__p61128138360">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdatePolicy__p1111261318366">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdatePolicy__p611281314369">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdatePolicy__p11121213113618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row2011261333611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdatePolicy__p2011201373615">policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdatePolicy__p19112161303615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdatePolicy__p1311251323619"><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__p611215132362">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__row13113111313362"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="UpdatePolicy__p191137138364">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="UpdatePolicy__p171131013203617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="UpdatePolicy__p111317132366">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="UpdatePolicy__p21132013163615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row31139138368"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p11130132367">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p19113413133611">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p151133131367">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p18113181314366">Whether to enable the policy</p>
<p id="UpdatePolicy__p2113161353612">Default: <strong id="UpdatePolicy__b111414136361">true</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row41131813113611"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p1911441318361">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p911461320365">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p15114813133617">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="UpdatePolicy__p171149136367">Policy Name</p>
<p id="UpdatePolicy__p1011421312362">Minimum: <strong id="UpdatePolicy__b111420137363">1</strong></p>
<p id="UpdatePolicy__p8114913163610">Maximum: <strong id="UpdatePolicy__b311491363610">64</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row191131413183616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p111431333617">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p12114191323617">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p011481343613"><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__p161148131362">Scheduling parameter</p>
</td>
</tr>
<tr id="UpdatePolicy__row21130134361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="UpdatePolicy__p12114413143615">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="UpdatePolicy__p611416132363">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="UpdatePolicy__p7115111317360"><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__p1711541323611">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__row4115413113616"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="UpdatePolicy__p41161134364">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="UpdatePolicy__p41161413103619">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="UpdatePolicy__p311610137368">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="UpdatePolicy__p811781383611">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row11115121311363"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1011731333619">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p111761323615">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p0117171314367">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p71171113113614">Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b1811851316368">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b1811811363612">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b812515253114">retention_duration_days</strong> cannot be configured at the same time.</p>
<p id="UpdatePolicy__p811815132368">Minimum: <strong id="UpdatePolicy__b11118513153613">0</strong></p>
<p id="UpdatePolicy__p71181813193615">Maximum: <strong id="UpdatePolicy__b18118181310367">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row211511323617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p3118151313615">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1011871316360">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p6118813143619">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p8118131311367">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row16116111313366"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p131180134369">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p711871318363">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p211881315365">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1711861315365">ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="UpdatePolicy__row111168138361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p611911323617">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p511951315368">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1211981312369">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p01191813123617">Maximum number of retained backups. The value can be <strong id="UpdatePolicy__b121209134365">-1</strong> or ranges from <strong id="UpdatePolicy__b171201013193615">0</strong> to <strong id="UpdatePolicy__b01204136365">99999</strong>. If the value is set to <strong id="UpdatePolicy__b4120171343610">-1</strong>, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and <strong id="UpdatePolicy__b61206133365">retention_duration_days</strong> are both left blank, the backups will be retained permanently. This parameter and <strong id="UpdatePolicy__b16868185311366">retention_duration_days</strong> cannot be configured at the same time.</p>
<p id="UpdatePolicy__p161203132369">Minimum: <strong id="UpdatePolicy__b912031313619">1</strong></p>
<p id="UpdatePolicy__p1012015137362">Maximum: <strong id="UpdatePolicy__b12120191313362">99999</strong></p>
<p id="UpdatePolicy__p4120171310362">Default: <strong id="UpdatePolicy__b8120213163617">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1511691353613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1512001314362">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p91202013133614">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p11207132364">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p10120151313613">Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b101201413173611">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b91201313113614">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b435013117372">retention_duration_days</strong> cannot be configured at the same time.</p>
<p id="UpdatePolicy__p5120913163613">Minimum: <strong id="UpdatePolicy__b1112020133368">0</strong></p>
<p id="UpdatePolicy__p412021393610">Maximum: <strong id="UpdatePolicy__b3120201343610">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row16116101333618"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p6120161313368">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p101201013103617">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1912081363620">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p5120161315364">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b1912041383615">99999</strong>. <strong id="UpdatePolicy__b5120171323614">-1</strong> indicates that the backups will not be cleared based on the retention duration. If this parameter and <strong id="UpdatePolicy__b131202013153614">max_backups</strong> are left blank at the same time, the backups will be retained permanently. This parameter cannot be configured if <strong id="UpdatePolicy__b1690142416127">max_backups</strong>, <strong id="UpdatePolicy__b1769022418128">day_backups</strong>, <strong id="UpdatePolicy__b96901524141217">week_backups</strong>, <strong id="UpdatePolicy__b17690024131218">month_backups</strong>, or <strong id="UpdatePolicy__b1669002411125">year_backups</strong> is configured.</p>
<p id="UpdatePolicy__p1312071311365">Minimum: <strong id="UpdatePolicy__b212121363611">1</strong></p>
<p id="UpdatePolicy__p912141333612">Maximum: <strong id="UpdatePolicy__b13121131383618">99999</strong></p>
<p id="UpdatePolicy__p51213135367">Default: <strong id="UpdatePolicy__b17121111373614">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row3116913183616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p17121101310369">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p412114131369">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p112111316360">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p912141383612">Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: <strong id="UpdatePolicy__b412141315360">day_backups</strong>, <strong id="UpdatePolicy__b14121131343611">week_backups</strong>, <strong id="UpdatePolicy__b1312118130365">month_backups</strong>, <strong id="UpdatePolicy__b141211813143612">year_backups</strong>. This parameter and <strong id="UpdatePolicy__b83999143910">retention_duration_days</strong> cannot be configured at the same time.</p>
</td>
</tr>
<tr id="UpdatePolicy__row311617137368"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p1012181319362">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p1412210139368">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p6122101310361">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p1412241318361">Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b4122131312366">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b412218135366">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b249671593716">retention_duration_days</strong> cannot be configured at the same time.</p>
</td>
</tr>
<tr id="UpdatePolicy__row1811610136365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="UpdatePolicy__p5122113183618">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="UpdatePolicy__p161220138361">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="UpdatePolicy__p1912261333611">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="UpdatePolicy__p112213132367">Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b612314132368">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b1012320135368">timezone</strong> is mandatory. This parameter and <strong id="UpdatePolicy__b98735187376">retention_duration_days</strong> cannot be configured at the same time.</p>
<p id="UpdatePolicy__p14123171353613">Minimum: <strong id="UpdatePolicy__b1112320136365">0</strong></p>
<p id="UpdatePolicy__p1412315138367">Maximum: <strong id="UpdatePolicy__b912391318366">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__row1312311383614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="UpdatePolicy__p7123191343615">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="UpdatePolicy__p312331312361">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="UpdatePolicy__p6123141316366">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="UpdatePolicy__p17123313143618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row4123111314364"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="UpdatePolicy__p5124201318363">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="UpdatePolicy__p13124161315361">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="UpdatePolicy__p412431312364"><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__p18124913133611">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__row112413133365"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="UpdatePolicy__p4124171312364">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="UpdatePolicy__p10124101303610">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="UpdatePolicy__p18125713123617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="UpdatePolicy__p9125513123618">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row412491310368"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="UpdatePolicy__p15125171315366">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="UpdatePolicy__p131251613193615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="UpdatePolicy__p51254133364">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="UpdatePolicy__p191251113173611">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__b71256132361">FREQ</strong>, <strong id="UpdatePolicy__b16125171363612">BYDAY</strong>, <strong id="UpdatePolicy__b512531317361">BYHOUR</strong>, <strong id="UpdatePolicy__b111251136364">BYMINUTE</strong>, and <strong id="UpdatePolicy__b13125713133614">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b41258137367">FREQ</strong> can be set only to <strong id="UpdatePolicy__b14125141318367">WEEKLY</strong> or <strong id="UpdatePolicy__b712519135367">DAILY</strong>. <strong id="UpdatePolicy__b16125141313620">BYDAY</strong> can be set to <strong id="UpdatePolicy__b1912518132362">MO</strong>, <strong id="UpdatePolicy__b161252013123618">TU</strong>, <strong id="UpdatePolicy__b1612571303612">WE</strong>, <strong id="UpdatePolicy__b5125513183619">TH</strong>, <strong id="UpdatePolicy__b912591312369">FR</strong>, <strong id="UpdatePolicy__b14125513203617">SA</strong>, and <strong id="UpdatePolicy__b1012571343615">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b17125161316365">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b1712551312365">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__b15125813193616">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__b51251613153617">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section101261213173617"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdatePolicy__p15126191313614"><strong id="UpdatePolicy__b1812601383614">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__row131261813183611"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="UpdatePolicy__p0127161310362">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="UpdatePolicy__p17127161311367">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="UpdatePolicy__p7127111363613">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row12126151316360"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="UpdatePolicy__p412751333614">policy</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="UpdatePolicy__p1212711313361"><a href="#UpdatePolicy__response_Policy">Policy</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="UpdatePolicy__p0127121363610">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__row3127191318367"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="UpdatePolicy__p91281131364">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="UpdatePolicy__p4128613193610">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="UpdatePolicy__p4128151303616">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row1412711131360"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p191291013133616">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p812914132363">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p712917135363">Whether the policy is enabled</p>
</td>
</tr>
<tr id="UpdatePolicy__row81279131366"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1912961363614">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1012961317363">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p12129913103610">Policy ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row312718135361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p1712914136369">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p4129111315365">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p18129111310361">Policy Name</p>
</td>
</tr>
<tr id="UpdatePolicy__row111271213193617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p15129141317364">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p17129131318366"><a href="#UpdatePolicy__response_PolicyoODCreate">PolicyoODCreate</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p5132101383611">Policy attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row15128161314365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p013211132365">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1513381323619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p141332013113612">Protection type, which can be <strong id="UpdatePolicy__b14133313123612">backup</strong> or <strong id="UpdatePolicy__b113331316365">replication</strong></p>
<p id="UpdatePolicy__p4133213103613">Enumeration values:</p>
<ul id="UpdatePolicy__ul15133101314369"><li id="UpdatePolicy__li413391312363"><strong id="UpdatePolicy__b12133171311366">backup</strong></li><li id="UpdatePolicy__li1133131315367"><strong id="UpdatePolicy__b3133513193610">replication</strong></li></ul>
</td>
</tr>
<tr id="UpdatePolicy__row151283134362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p913315139366">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p1513341310363"><a href="#UpdatePolicy__response_PolicyTriggerResp">PolicyTriggerResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p19133191312365">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="UpdatePolicy__row12128513173620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="UpdatePolicy__p51348136361">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="UpdatePolicy__p13134151333616">Array of <a href="#UpdatePolicy__response_PolicyAssociateVault">PolicyAssociateVault</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="UpdatePolicy__p1213416134366">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__row813431323610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="UpdatePolicy__p613581393619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="UpdatePolicy__p20135171353614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="UpdatePolicy__p813631316365">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row813413133364"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p12136413173618">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p2013613132363">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p191361113203616">Specifies the number of retained daily backups. The latest backup of each day is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b121361613173615">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b513620132362">timezone</strong> is mandatory.</p>
<p id="UpdatePolicy__p51361713133615">Minimum: <strong id="UpdatePolicy__b131361136363">0</strong></p>
<p id="UpdatePolicy__p15136181317361">Maximum: <strong id="UpdatePolicy__b16136191310363">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1513451311362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1413681320368">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p0136191363612">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p7136513143611">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="UpdatePolicy__row16134151313610"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p15136713203616">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p21371113153619">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p913751318368">ID of the replication destination region, which is mandatory for cross-region replication. The value consists of 0 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="UpdatePolicy__row513418134365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p143291313143615">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p1032951310364">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p4329213173617">Maximum number of retained backups. The value can be <strong id="UpdatePolicy__b23291713173612">-1</strong> or ranges from <strong id="UpdatePolicy__b1032911310364">0</strong> to <strong id="UpdatePolicy__b1232941393618">99999</strong>. If the value is set to <strong id="UpdatePolicy__b6329141317368">-1</strong>, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter and <strong id="UpdatePolicy__b23299138368">retention_duration_days</strong> are both left blank, the backups will be retained permanently.</p>
<p id="UpdatePolicy__p332931323615">Minimum: <strong id="UpdatePolicy__b1232961310369">1</strong></p>
<p id="UpdatePolicy__p143291413123617">Maximum: <strong id="UpdatePolicy__b1932951319368">99999</strong></p>
<p id="UpdatePolicy__p532971373615">Default: <strong id="UpdatePolicy__b332981383618">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row101351138360"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p17329191311367">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p33291413183617">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p232991315361">Specifies the number of retained monthly backups. The latest backup of each month is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b33291013133619">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b1532921320365">timezone</strong> is mandatory.</p>
<p id="UpdatePolicy__p1232981313619">Minimum: <strong id="UpdatePolicy__b43291813183618">0</strong></p>
<p id="UpdatePolicy__p4329121363619">Maximum: <strong id="UpdatePolicy__b17329111315365">100</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1513541363620"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p5329111373611">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p14329141317367">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p14329141343611">Duration of retaining a backup, in days. The maximum value is <strong id="UpdatePolicy__b9329413163614">99999</strong>. <strong id="UpdatePolicy__b1532971313362">-1</strong> indicates that the backups will not be cleared based on the retention duration. If this parameter and <strong id="UpdatePolicy__b13329113153617">max_backups</strong> are left blank at the same time, the backups will be retained permanently.</p>
<p id="UpdatePolicy__p3329151363613">Minimum: <strong id="UpdatePolicy__b1032919132368">1</strong></p>
<p id="UpdatePolicy__p632920131361">Maximum: <strong id="UpdatePolicy__b43292013183615">99999</strong></p>
<p id="UpdatePolicy__p143291013143615">Default: <strong id="UpdatePolicy__b1032991310365">-1</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row1513518132362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p1132981318363">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p532911323613">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p17329141318362">Time zone where the user is located, for example, UTC+08:00. Set this parameter if you have configured any of the parameters: <strong id="UpdatePolicy__b1332917134360">day_backups</strong>, <strong id="UpdatePolicy__b73291613123616">week_backups</strong>, <strong id="UpdatePolicy__b232961312365">month_backups</strong>, <strong id="UpdatePolicy__b1232917133366">year_backups</strong>.</p>
</td>
</tr>
<tr id="UpdatePolicy__row20135181310361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p43291139364">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p932931310366">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p1332981333616">Specifies the number of retained weekly backups. The latest backup of each week is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b19329513133610">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b173291213123615">timezone</strong> is mandatory.</p>
</td>
</tr>
<tr id="UpdatePolicy__row4135131316367"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="UpdatePolicy__p3329201333619">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="UpdatePolicy__p032916131366">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="UpdatePolicy__p12330141343615">Specifies the number of retained yearly backups. The latest backup of each year is saved in the long term. This parameter can be effective together with the maximum number of retained backups specified by <strong id="UpdatePolicy__b16330181316366">max_backups</strong>. The value ranges from 0 to 100. If this parameter is configured, <strong id="UpdatePolicy__b73301013193616">timezone</strong> is mandatory.</p>
<p id="UpdatePolicy__p15330913203614">Minimum: <strong id="UpdatePolicy__b73301013163619">0</strong></p>
<p id="UpdatePolicy__p14330161343614">Maximum: <strong id="UpdatePolicy__b17330113183619">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__row014131333614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="UpdatePolicy__p733041353615">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="UpdatePolicy__p12330151333613">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="UpdatePolicy__p163301513163610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row2141161317365"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p11330213123619">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p1433018137364">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p1933021333616">Scheduler ID</p>
</td>
</tr>
<tr id="UpdatePolicy__row71414133369"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p1633051383610">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p1733011373614">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p1330191333618">Scheduler name</p>
</td>
</tr>
<tr id="UpdatePolicy__row8141191315362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p4330141333610">properties</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p9330121303611"><a href="#UpdatePolicy__response_PolicyTriggerPropertiesResp">PolicyTriggerPropertiesResp</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p13301813123611">Scheduler attributes</p>
</td>
</tr>
<tr id="UpdatePolicy__row14141813163617"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="UpdatePolicy__p173309134369">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="UpdatePolicy__p1433011363616">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="UpdatePolicy__p9330121314364">Scheduler type. Currently, only <strong id="UpdatePolicy__b633012130365">time</strong> (periodic scheduling) is supported.</p>
<p id="UpdatePolicy__p17330181316368">Enumeration values:</p>
<ul id="UpdatePolicy__ul19330713103616"><li id="UpdatePolicy__li3330161373617"><strong id="UpdatePolicy__b1733041323615">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__row71421136368"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="UpdatePolicy__p23311213113611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="UpdatePolicy__p10331151333620">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="UpdatePolicy__p9331141383615">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row19142191316362"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p1533121313618">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p2331113103612">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p12331171383612">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__b03311113113612">FREQ</strong>, <strong id="UpdatePolicy__b2331131317365">BYDAY</strong>, <strong id="UpdatePolicy__b5331913193613">BYHOUR</strong>, <strong id="UpdatePolicy__b7331313163611">BYMINUTE</strong>, and <strong id="UpdatePolicy__b833119134363">INTERVAL</strong> parameters. <strong id="UpdatePolicy__b3331171313361">FREQ</strong> can be set only to <strong id="UpdatePolicy__b5331161343615">WEEKLY</strong> or <strong id="UpdatePolicy__b1533116130367">DAILY</strong>. <strong id="UpdatePolicy__b14331013143614">BYDAY</strong> can be set to <strong id="UpdatePolicy__b10331111316364">MO</strong>, <strong id="UpdatePolicy__b23311513193620">TU</strong>, <strong id="UpdatePolicy__b1833191319366">WE</strong>, <strong id="UpdatePolicy__b1833151320361">TH</strong>, <strong id="UpdatePolicy__b1233171314360">FR</strong>, <strong id="UpdatePolicy__b1333141315362">SA</strong>, and <strong id="UpdatePolicy__b633191353614">SU</strong> (seven days of a week). <strong id="UpdatePolicy__b14331121317367">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="UpdatePolicy__b7331151383613">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__b193316138367">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__b17331513103615">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="UpdatePolicy__row9142161311361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="UpdatePolicy__p8331713133611">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="UpdatePolicy__p433161311363">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="UpdatePolicy__p133311713103617">Start time of the scheduler, for example, <strong id="UpdatePolicy__b1833116131366">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__row161431913153620"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="UpdatePolicy__p1233161383619">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="UpdatePolicy__p43314136361">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="UpdatePolicy__p1533171316364">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row20143121353619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p11331111318365">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p153319134364">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p193319133366">ID of the associated remote vault</p>
</td>
</tr>
<tr id="UpdatePolicy__row3143013143615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="UpdatePolicy__p183311113143610">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="UpdatePolicy__p1933131311362">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="UpdatePolicy__p2033171313614">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section6331121310368"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="UpdatePolicy__screen1333161312360">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+08: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__section10332613153610"><h4 class="sectiontitle">Example Responses</h4><p id="UpdatePolicy__p83321713103620"><strong id="UpdatePolicy__b4332713153619">Status code: 200</strong></p>
<p id="UpdatePolicy__p133321713183611">OK</p>
<pre class="screen" id="UpdatePolicy__screen23321313133611">{
"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+08:00"
},
"operation_type" : "backup",
"id" : "cbb3ce6f-3332-4e7c-b98e-77290d8471ff"
}
}</pre>
</div>
<div class="section" id="UpdatePolicy__section633214138361"><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__row13147111333612"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="UpdatePolicy__p1433219137363">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__p033281316363">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdatePolicy__row1814771312369"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="UpdatePolicy__p1433251318367">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="UpdatePolicy__p5332191333613">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdatePolicy__section12332191314364"><h4 class="sectiontitle">Error Codes</h4><p id="UpdatePolicy__p20332313163615">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_300000007.html">Policies</a></div>
</div>
</div>
View Git Blame Copy Permalink