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

390 lines
31 KiB
HTML
Raw Blame History

<a name="ShowPolicy"></a><a name="ShowPolicy"></a>
<h1 class="topictitle1">Querying a Single Policy</h1>
<div id="body1708331107508"><div class="section" id="ShowPolicy__section646416583241"><h4 class="sectiontitle">Function</h4><p id="ShowPolicy__p1464145819248">This API is used to query a single policy.</p>
</div>
<div class="section" id="ShowPolicy__section15464125820240"><h4 class="sectiontitle">URI</h4><p id="ShowPolicy__p104642058132413">GET /v3/{project_id}/policies/{policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__table15465165813241" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowPolicy__row12464195852419"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowPolicy__p446595819245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowPolicy__p64651658132411">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowPolicy__p1646555811241">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowPolicy__p646535813247">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row1646417585244"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPolicy__p1946510589242">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPolicy__p1846585813248">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPolicy__p3465115812419">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPolicy__p0465135813241">Policy ID</p>
</td>
</tr>
<tr id="ShowPolicy__row6464105872411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPolicy__p14652585248">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPolicy__p146515872416">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPolicy__p10466155819248">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPolicy__p8466165832417">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section14466165811249"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="ShowPolicy__row846655811246"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowPolicy__p11466195812247">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowPolicy__p164661058182413">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowPolicy__p8466155832419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowPolicy__p546714584240">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row124661158192416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPolicy__p1646718584242">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPolicy__p12467165820249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPolicy__p1446710583241">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPolicy__p114672058132412">User token</p>
<p id="ShowPolicy__p1146711581245">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ShowPolicy__b18467115819249">X-Subject-Token</strong> in the response header is the user token.</p>
<p id="ShowPolicy__p246785810240">Default: <strong id="ShowPolicy__b1467758112414">MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section1846718580241"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowPolicy__p164671958192416"><strong id="ShowPolicy__b1346755862419">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_PolicyCreateResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="ShowPolicy__row104671358102418"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowPolicy__p94681658112412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowPolicy__p104688585247">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowPolicy__p19468158132413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row144672058172417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPolicy__p1546845814242">policy</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPolicy__p14681358112418"><a href="#ShowPolicy__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="ShowPolicy__p24682058152411">Response to the request for creating a policy</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowPolicy__response_Policy"></a><a name="response_Policy"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_Policy" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Policy</caption><thead align="left"><tr id="ShowPolicy__row9468175812243"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowPolicy__p1146912585246">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowPolicy__p1469558122411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowPolicy__p1746975812240">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row1346815581241"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p946965814248">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p10469155816240">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p164691258122420">Whether the policy is enabled</p>
</td>
</tr>
<tr id="ShowPolicy__row19469195822414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p17470158172414">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p14470125816243">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p94701589245">Policy ID</p>
</td>
</tr>
<tr id="ShowPolicy__row4469105862416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p9470195812242">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p74701158162415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p64701582242">Policy Name</p>
</td>
</tr>
<tr id="ShowPolicy__row1046995813244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p16470958182416">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p14701158102414"><a href="#ShowPolicy__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="ShowPolicy__p5470175812242">Policy attributes</p>
</td>
</tr>
<tr id="ShowPolicy__row1646945882413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p1470358152411">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p13470558102415">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p104708581249">Protection type, which can be <strong id="ShowPolicy__b147019586249">backup</strong> or <strong id="ShowPolicy__b447016585242">replication</strong></p>
<p id="ShowPolicy__p1847035872412">Enumeration values:</p>
<ul id="ShowPolicy__ul947118580246"><li id="ShowPolicy__li15471115810242"><p id="ShowPolicy__p5471458132414"><a name="ShowPolicy__li15471115810242"></a><a name="li15471115810242"></a><strong id="ShowPolicy__b10471458192418">backup</strong></p>
</li><li id="ShowPolicy__li15471358122412"><p id="ShowPolicy__p18471195842414"><a name="ShowPolicy__li15471358122412"></a><a name="li15471358122412"></a><strong id="ShowPolicy__b1747165872411">replication</strong></p>
</li></ul>
</td>
</tr>
<tr id="ShowPolicy__row4469175818249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p3471115815247">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p847110581244"><a href="#ShowPolicy__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="ShowPolicy__p047114586247">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="ShowPolicy__row14469958132414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p194716587241">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p1847105815248">Array of <a href="#ShowPolicy__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="ShowPolicy__p9471658182414">Associated vault</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowPolicy__response_PolicyoODCreate"></a><a name="response_PolicyoODCreate"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_PolicyoODCreate" frame="border" border="1" rules="all"><caption><b>Table 5 </b>PolicyoODCreate</caption><thead align="left"><tr id="ShowPolicy__row94727586245"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowPolicy__p16473155862412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowPolicy__p04738581249">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowPolicy__p13473175811246">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row16472165814243"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p1247345814247">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p19473458142415">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p547305814241">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="ShowPolicy__b124731458182419">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b18473258132410">0</strong> to <strong id="ShowPolicy__b4473105817243">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b14473258182419">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b347365820243">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p1947317580246">Minimum: <strong id="ShowPolicy__b1247311582245">0</strong></p>
<p id="ShowPolicy__p54731558192415">Maximum: <strong id="ShowPolicy__b1647419586245">100</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row847285813247"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p4474135815248">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p9474758182411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p947417588241">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="ShowPolicy__row5472858122413"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p154745585244">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p4474658172414">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1247465811242">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="ShowPolicy__row847218586248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p144742586247">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p14474165882411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p124741058172413">Maximum number of backups that can be automatically created for an object. The value can be -1 or 1-99999. If the value is set to -1, backups will not be cleared by the quantity of backups. If this parameter and retention_duration_days are both left blank, backups will be retained permanently. This field and retention_duration_days cannot be both set.</p>
<p id="ShowPolicy__p547520584246">Minimum: <strong id="ShowPolicy__b14475135812242">1</strong></p>
<p id="ShowPolicy__p74751458172417">Maximum: <strong id="ShowPolicy__b154752058162417">99999</strong></p>
<p id="ShowPolicy__p5475105842419">Default: <strong id="ShowPolicy__b8475758142419">-1</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row9472165892419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p194750588244">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p5475155842418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1147515818249">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="ShowPolicy__b3475175832411">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b15475105814247">0</strong> to <strong id="ShowPolicy__b44751458112418">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b1047545815246">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b10475115812411">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p1547515583248">Minimum: <strong id="ShowPolicy__b247511580249">0</strong></p>
<p id="ShowPolicy__p347575842414">Maximum: <strong id="ShowPolicy__b947520588244">100</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row13472145815241"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p347535822416">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p10475155816244">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p2475358202416">Duration of retaining a backup, in days. The maximum value is <strong id="ShowPolicy__b747510587248">99999</strong>. If the value is set to <strong id="ShowPolicy__b174751658112413">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="ShowPolicy__b10475205832414">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="ShowPolicy__b174761558102420">max_backups</strong>, <strong id="ShowPolicy__b74762058202418">day_backups</strong>, <strong id="ShowPolicy__b10476175852416">week_backups</strong>, <strong id="ShowPolicy__b4476158132419">month_backups</strong>, and <strong id="ShowPolicy__b1147645842413">year_backups</strong>.</p>
<p id="ShowPolicy__p24761358152416">Minimum: <strong id="ShowPolicy__b1047685852410">1</strong></p>
<p id="ShowPolicy__p20476125872410">Maximum: <strong id="ShowPolicy__b347685842418">99999</strong></p>
<p id="ShowPolicy__p2476135892419">Default: <strong id="ShowPolicy__b24760582245">-1</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row147235810248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p94761658182411">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p12476145822416">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p6476195852410">Time zone where the user is located. The format is UTC+01:00. If any of the parameters of yearly, monthly, weekly, or daily backup is selected, this parameter cannot be left empty.</p>
</td>
</tr>
<tr id="ShowPolicy__row147245818249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p1247610582243">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p1747665811241">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1047618584244">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="ShowPolicy__b2047685814248">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b1347610582243">0</strong> to <strong id="ShowPolicy__b0476758122415">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b847613589246">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b1447655812245">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="ShowPolicy__row14472165852417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p1847610589247">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p147625810248">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1247615818248">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="ShowPolicy__b194771558152414">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b8477125812242">0</strong> to <strong id="ShowPolicy__b1547725812413">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b15477195818249">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b16477195852416">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p2047725872410">Minimum: <strong id="ShowPolicy__b1847795882416">0</strong></p>
<p id="ShowPolicy__p24771758162416">Maximum: <strong id="ShowPolicy__b12477185882411">100</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowPolicy__response_PolicyTriggerResp"></a><a name="response_PolicyTriggerResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_PolicyTriggerResp" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PolicyTriggerResp</caption><thead align="left"><tr id="ShowPolicy__row144772580244"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowPolicy__p147811582246">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowPolicy__p1847816585248">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowPolicy__p1947820582248">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row17477758112419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p447895811243">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p64783587241">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p1147818581248">Scheduler ID</p>
</td>
</tr>
<tr id="ShowPolicy__row94771580242"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p1447820585244">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p1847815852410">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p447818582248">Scheduler name</p>
</td>
</tr>
<tr id="ShowPolicy__row14477458192415"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p174781458112412">properties</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p1647810581241"><a href="#ShowPolicy__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="ShowPolicy__p6478125810241">Scheduler attributes</p>
</td>
</tr>
<tr id="ShowPolicy__row1747719583243"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p1147945816244">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p1479658132420">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p147975832419">Scheduler type. Currently, only <strong id="ShowPolicy__b4479458112417">time</strong> (periodic scheduling) is supported.</p>
<p id="ShowPolicy__p147995816244">Enumeration values:</p>
<ul id="ShowPolicy__ul10479205862416"><li id="ShowPolicy__li1647910587249"><p id="ShowPolicy__p14479125842417"><a name="ShowPolicy__li1647910587249"></a><a name="li1647910587249"></a><strong id="ShowPolicy__b347910587240">time</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowPolicy__response_PolicyTriggerPropertiesResp"></a><a name="response_PolicyTriggerPropertiesResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_PolicyTriggerPropertiesResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PolicyTriggerPropertiesResp</caption><thead align="left"><tr id="ShowPolicy__row12479175842416"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowPolicy__p17480658112418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowPolicy__p1648018587248">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowPolicy__p248095822411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row747918581249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPolicy__p748015582244">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPolicy__p94801858112411">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPolicy__p3480105852418">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="ShowPolicy__b048075812242">FREQ</strong>, <strong id="ShowPolicy__b16480195817243">BYDAY</strong>, <strong id="ShowPolicy__b1348014588246">BYHOUR</strong>, <strong id="ShowPolicy__b7480105812248">BYMINUTE</strong>, and <strong id="ShowPolicy__b13480105862418">INTERVAL</strong> parameters. <strong id="ShowPolicy__b748017585240">FREQ</strong> can be set only to <strong id="ShowPolicy__b44801958132417">WEEKLY</strong> or <strong id="ShowPolicy__b14480658102418">DAILY</strong>. <strong id="ShowPolicy__b94801258192415">BYDAY</strong> can be set to <strong id="ShowPolicy__b5480185802412">MO</strong>, <strong id="ShowPolicy__b648035810242">TU</strong>, <strong id="ShowPolicy__b24802584240">WE</strong>, <strong id="ShowPolicy__b10480558182417">TH</strong>, <strong id="ShowPolicy__b54803584242">FR</strong>, <strong id="ShowPolicy__b1548045892419">SA</strong>, and <strong id="ShowPolicy__b14480185814246">SU</strong> (seven days of a week). <strong id="ShowPolicy__b3480125832418">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="ShowPolicy__b44801158132410">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="ShowPolicy__b148015589246">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="ShowPolicy__b1748015813243">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row12479175813244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPolicy__p74801058172417">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPolicy__p748035862419">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPolicy__p11481158172411">Start time of the scheduler, for example, <strong id="ShowPolicy__b0481105812241">2020-01-08 09:59:49</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ShowPolicy__response_PolicyAssociateVault"></a><a name="response_PolicyAssociateVault"></a><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__response_PolicyAssociateVault" frame="border" border="1" rules="all"><caption><b>Table 8 </b>PolicyAssociateVault</caption><thead align="left"><tr id="ShowPolicy__row54811958192417"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowPolicy__p3481758172411">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowPolicy__p13481175802419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowPolicy__p1548175892416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row1448145813248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowPolicy__p148118584242">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowPolicy__p114821858102414">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowPolicy__p6482135862412">ID of the associated remote vault</p>
</td>
</tr>
<tr id="ShowPolicy__row1648145812242"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowPolicy__p848212587240">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowPolicy__p1048205832418">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowPolicy__p1448255810248">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section64821258192415"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowPolicy__screen8482165811241">GET https://{endpoint}/v3/{project_id}/policies/{policy_id}</pre>
</div>
<div class="section" id="ShowPolicy__section204822581243"><h4 class="sectiontitle">Example Responses</h4><p id="ShowPolicy__p74823586245"><strong id="ShowPolicy__b3482125813246">Status code: 200</strong></p>
<p id="ShowPolicy__p1448265813240">OK</p>
<pre class="screen" id="ShowPolicy__screen16483145822411">{
"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" : {
"retention_duration_days" : 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="ShowPolicy__section5484185812247"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ShowPolicy__row1048425815243"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowPolicy__p048410585241">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ShowPolicy__p13484175810243">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row84841258182420"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPolicy__p194841458142411">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPolicy__p9485185815249">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section74858582240"><h4 class="sectiontitle">Error Codes</h4><p id="ShowPolicy__p748555802412">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