yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
bf0249500a5ed7b17b83a0aff94fb5d48195ebc7
doc-exports/docs/cbr/api-ref/ShowPolicy.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

387 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__section53564912499"><h4 class="sectiontitle">Function</h4><p id="ShowPolicy__p535617913495">This API is used to query a single policy.</p>
</div>
<div class="section" id="ShowPolicy__section53563944911"><h4 class="sectiontitle">URI</h4><p id="ShowPolicy__p1835649114913">GET /v3/{project_id}/policies/{policy_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ShowPolicy__table635709124915" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ShowPolicy__row33579914492"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ShowPolicy__p83589914919">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ShowPolicy__p163581698499">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ShowPolicy__p135810915499">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ShowPolicy__p635814914914">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row2357495494"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPolicy__p3358892498">policy_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPolicy__p13358795494">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPolicy__p03581698491">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPolicy__p183591914915">Policy ID</p>
</td>
</tr>
<tr id="ShowPolicy__row235729164913"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ShowPolicy__p103599910495">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ShowPolicy__p113593914917">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ShowPolicy__p113591493499">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ShowPolicy__p2359699494">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section335979174916"><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__row173603924916"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ShowPolicy__p13360129164919">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ShowPolicy__p173618984916">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ShowPolicy__p53619904919">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ShowPolicy__p236112913499">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row10360129174911"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ShowPolicy__p20361499498">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ShowPolicy__p19361096496">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ShowPolicy__p2036112913496">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ShowPolicy__p113611197494">User token</p>
<p id="ShowPolicy__p736112913499">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ShowPolicy__b1036129114919">X-Subject-Token</strong> in the response header is the user token.</p>
<p id="ShowPolicy__p43619917494">Default: <strong id="ShowPolicy__b636116954918">MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX...</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section936279184911"><h4 class="sectiontitle">Response Parameters</h4><p id="ShowPolicy__p936269104911"><strong id="ShowPolicy__b5362139134915">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__row1536212904913"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ShowPolicy__p1836210911494">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ShowPolicy__p17363159134918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ShowPolicy__p19363694498">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row736269124919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ShowPolicy__p63633934911">policy</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ShowPolicy__p63636914915"><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__p1736317915496">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__row73636924918"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ShowPolicy__p143641196495">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ShowPolicy__p163641190499">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ShowPolicy__p5365096497">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row5363179194918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p1936519964916">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p63651097498">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p63658904913">Whether the policy is enabled</p>
</td>
</tr>
<tr id="ShowPolicy__row13363499490"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p536516915497">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p53655911490">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p236518964912">Policy ID</p>
</td>
</tr>
<tr id="ShowPolicy__row43631497495"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p43651194495">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p1536516904919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p11365294498">Policy Name</p>
</td>
</tr>
<tr id="ShowPolicy__row11363691494"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p1736611994912">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p436629124915"><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__p33661596492">Policy attributes</p>
</td>
</tr>
<tr id="ShowPolicy__row1136420984910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p153666914914">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p143661895495">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ShowPolicy__p133661594495">Protection type, which can be <strong id="ShowPolicy__b133665918494">backup</strong> or <strong id="ShowPolicy__b73661916499">replication</strong></p>
<p id="ShowPolicy__p123668916493">Enumeration values:</p>
<ul id="ShowPolicy__ul23662994915"><li id="ShowPolicy__li163661491496"><strong id="ShowPolicy__b163661099498">backup</strong></li><li id="ShowPolicy__li23662095494"><strong id="ShowPolicy__b173661984911">replication</strong></li></ul>
</td>
</tr>
<tr id="ShowPolicy__row1236429204911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p16366197498">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p63671918499"><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__p12367694492">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="ShowPolicy__row93649984917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ShowPolicy__p1536716914919">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ShowPolicy__p123679954918">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__p193681993498">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__row10368394496"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ShowPolicy__p1236917954912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ShowPolicy__p23691099493">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ShowPolicy__p203690917494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row1736889144917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p1737015924920">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p10370199184918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1637018915498">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__b43701915491">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b137010913497">0</strong> to <strong id="ShowPolicy__b123700912497">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b1737013913492">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b1937010917492">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p737039154912">Minimum: <strong id="ShowPolicy__b137013916494">0</strong></p>
<p id="ShowPolicy__p2037015910493">Maximum: <strong id="ShowPolicy__b1337012994914">100</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row23686984910"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p637049114910">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p53705974914">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1437015994917">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="ShowPolicy__row23681091497"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p12370897499">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p1437049104918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p737112984918">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__row83684944911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p337117911493">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p3371169194914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1237249124916">Maximum number of backups that can be automatically created for a backup object. The value can be <strong id="ShowPolicy__b1437215918491">-1</strong> or ranges from <strong id="ShowPolicy__b1537299174915">0</strong> to <strong id="ShowPolicy__b8372692490">99999</strong>. If the value is set to <strong id="ShowPolicy__b1137213916497">-1</strong>, backups will not be cleared by quantity limit. If this parameter and <strong id="ShowPolicy__b1537211954913">retention_duration_days</strong> are left blank at the same time, the backups will be retained permanently. This parameter and <strong id="ShowPolicy__b183722917494">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p123721898496">Minimum: <strong id="ShowPolicy__b637215914913">1</strong></p>
<p id="ShowPolicy__p1237289104915">Maximum: <strong id="ShowPolicy__b2372195492">99999</strong></p>
<p id="ShowPolicy__p153723911491">Default: <strong id="ShowPolicy__b103724916494">-1</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row15368109174916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p2372139184911">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p83728914916">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1237316913496">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__b113731696495">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b163731796496">0</strong> to <strong id="ShowPolicy__b83731393498">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b1937310910495">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b1637399114913">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p737317944917">Minimum: <strong id="ShowPolicy__b13373119174914">0</strong></p>
<p id="ShowPolicy__p2037312912491">Maximum: <strong id="ShowPolicy__b937316914490">100</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row17369498490"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p183733913494">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p1637318954915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p93731193491">Duration of retaining a backup, in days. The maximum value is <strong id="ShowPolicy__b13733974911">99999</strong>. If the value is set to <strong id="ShowPolicy__b1437318915491">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="ShowPolicy__b1837329104911">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__b1237312916497">max_backups</strong>, <strong id="ShowPolicy__b1637312912498">day_backups</strong>, <strong id="ShowPolicy__b337320915498">week_backups</strong>, <strong id="ShowPolicy__b33731696492">month_backups</strong>, and <strong id="ShowPolicy__b1137320917498">year_backups</strong>.</p>
<p id="ShowPolicy__p73737918492">Minimum: <strong id="ShowPolicy__b143738913496">1</strong></p>
<p id="ShowPolicy__p4373694495">Maximum: <strong id="ShowPolicy__b43745944914">99999</strong></p>
<p id="ShowPolicy__p1237439144913">Default: <strong id="ShowPolicy__b1374119144919">-1</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row836969124913"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p2037439104913">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p1437409114919">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p03747919498">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="ShowPolicy__b93741996496">day_backups</strong>, <strong id="ShowPolicy__b143741492498">week_backups</strong>, <strong id="ShowPolicy__b237479174915">month_backups</strong>, <strong id="ShowPolicy__b13741914494">year_backups</strong>.</p>
</td>
</tr>
<tr id="ShowPolicy__row836929164914"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p1937429194920">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p637417974915">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p1937419154914">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__b73741199490">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b1037413944918">0</strong> to <strong id="ShowPolicy__b437459134915">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b537410994918">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b537410924912">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="ShowPolicy__row336959144911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ShowPolicy__p03749911496">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ShowPolicy__p437510919499">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ShowPolicy__p437569164910">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__b1937559194911">max_backups</strong> will both be applied. The value ranges from <strong id="ShowPolicy__b537517917496">0</strong> to <strong id="ShowPolicy__b193756964915">100</strong>. If this parameter is configured, <strong id="ShowPolicy__b19375195495">timezone</strong> is mandatory. This parameter and <strong id="ShowPolicy__b537512917496">retention_duration_days</strong> cannot be both applied.</p>
<p id="ShowPolicy__p337599124919">Minimum: <strong id="ShowPolicy__b1937514916491">0</strong></p>
<p id="ShowPolicy__p2375292497">Maximum: <strong id="ShowPolicy__b1137579174915">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__row183751924914"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ShowPolicy__p173761495499">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ShowPolicy__p13376159174918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ShowPolicy__p153772917491">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row133751893498"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p1437715913498">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p17377790495">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p037717904916">Scheduler ID</p>
</td>
</tr>
<tr id="ShowPolicy__row15376139124919"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p0377129134915">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p1637719124918">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p13771091495">Scheduler name</p>
</td>
</tr>
<tr id="ShowPolicy__row537679104918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p437714918492">properties</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p637712919491"><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__p137710934919">Scheduler attributes</p>
</td>
</tr>
<tr id="ShowPolicy__row6376194499"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ShowPolicy__p143772092492">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ShowPolicy__p1137815919491">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ShowPolicy__p73785924910">Scheduler type. Currently, only <strong id="ShowPolicy__b1037817913497">time</strong> (periodic scheduling) is supported.</p>
<p id="ShowPolicy__p737811924911">Enumeration values:</p>
<ul id="ShowPolicy__ul1378129154915"><li id="ShowPolicy__li03787918496"><strong id="ShowPolicy__b183781791495">time</strong></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__row113781299492"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ShowPolicy__p737929164917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ShowPolicy__p538015913491">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ShowPolicy__p2380149154910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row33786974912"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPolicy__p43804924916">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPolicy__p938017914495">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPolicy__p33804954914">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__b8380296499">FREQ</strong>, <strong id="ShowPolicy__b1338019134915">BYDAY</strong>, <strong id="ShowPolicy__b4380594499">BYHOUR</strong>, <strong id="ShowPolicy__b1538019114914">BYMINUTE</strong>, and <strong id="ShowPolicy__b93801597493">INTERVAL</strong> parameters. <strong id="ShowPolicy__b133837994914">FREQ</strong> can be set only to <strong id="ShowPolicy__b538399174912">WEEKLY</strong> or <strong id="ShowPolicy__b113831896492">DAILY</strong>. <strong id="ShowPolicy__b143831912490">BYDAY</strong> can be set to <strong id="ShowPolicy__b1638389154919">MO</strong>, <strong id="ShowPolicy__b183831984913">TU</strong>, <strong id="ShowPolicy__b438349184915">WE</strong>, <strong id="ShowPolicy__b538317920497">TH</strong>, <strong id="ShowPolicy__b43831399494">FR</strong>, <strong id="ShowPolicy__b4383129184916">SA</strong>, and <strong id="ShowPolicy__b163831497492">SU</strong> (seven days of a week). <strong id="ShowPolicy__b123836914916">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="ShowPolicy__b338349144913">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__b19383790497">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__b13383209134912">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="ShowPolicy__row143784913493"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ShowPolicy__p16383893492">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ShowPolicy__p1438318964912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ShowPolicy__p23831997492">Start time of the scheduler, for example, <strong id="ShowPolicy__b838319134916">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__row13842994914"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ShowPolicy__p138718944911">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ShowPolicy__p13888924916">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ShowPolicy__p6388169134910">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row1638417934917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowPolicy__p17388189194919">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowPolicy__p1638869114912">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowPolicy__p1938929104919">ID of the associated remote vault</p>
</td>
</tr>
<tr id="ShowPolicy__row138512934911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ShowPolicy__p138913916494">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ShowPolicy__p1338920920494">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ShowPolicy__p103893919497">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section438939174917"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ShowPolicy__screen163907904912">GET https://{endpoint}/v3/{project_id}/policies/{policy_id}</pre>
</div>
<div class="section" id="ShowPolicy__section1339019912491"><h4 class="sectiontitle">Example Responses</h4><p id="ShowPolicy__p12390393499"><strong id="ShowPolicy__b439013917491">Status code: 200</strong></p>
<p id="ShowPolicy__p1939019124917">OK</p>
<pre class="screen" id="ShowPolicy__screen339259194916">{
"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__section1394694498"><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__row1639517994917"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ShowPolicy__p1339516919492">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__p2039612984915">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ShowPolicy__row539515934914"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ShowPolicy__p15396139194919">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ShowPolicy__p4396998497">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ShowPolicy__section1039612994919"><h4 class="sectiontitle">Error Codes</h4><p id="ShowPolicy__p83961994497">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