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

424 lines
34 KiB
HTML
Raw Blame History

<a name="ListPolicies"></a><a name="ListPolicies"></a>
<h1 class="topictitle1">Querying the Policy List</h1>
<div id="body1708331107508"><div class="section" id="ListPolicies__section61971058182413"><h4 class="sectiontitle">Function</h4><p id="ListPolicies__p61972589242">This API is used to query the policy list.</p>
</div>
<div class="section" id="ListPolicies__section1819717584247"><h4 class="sectiontitle">URI</h4><p id="ListPolicies__p11981958202419">GET /v3/{project_id}/policies</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__table1019813588243" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="ListPolicies__row13198858182418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListPolicies__p6198758172416">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListPolicies__p41987588242">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListPolicies__p61991058142410">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListPolicies__p171995585242">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row121981158152411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListPolicies__p71991582244">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListPolicies__p51991058182414">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListPolicies__p181996581241">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListPolicies__p101997583245">Project ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__table1420055832420" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="ListPolicies__row101994588244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListPolicies__p320055810247">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListPolicies__p12001458182410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListPolicies__p1020025892411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListPolicies__p112001358192413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row13199658142413"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListPolicies__p3200195810246">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListPolicies__p12200135814241">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListPolicies__p172001258122412">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListPolicies__p220018587246">Policy type, which can be <strong id="ListPolicies__b142001258122412">backup</strong> or <strong id="ListPolicies__b6200165813243">replication</strong></p>
<p id="ListPolicies__p4200758122419">Enumeration values:</p>
<ul id="ListPolicies__ul9200115810245"><li id="ListPolicies__li12200758122410"><p id="ListPolicies__p192011058102411"><a name="ListPolicies__li12200758122410"></a><a name="li12200758122410"></a><strong id="ListPolicies__b162013582241">backup</strong></p>
</li><li id="ListPolicies__li182011580246"><p id="ListPolicies__p4201858182414"><a name="ListPolicies__li182011580246"></a><a name="li182011580246"></a><strong id="ListPolicies__b4201958102416">replication</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListPolicies__row12199205819241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListPolicies__p14201958162420">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListPolicies__p620117586246">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListPolicies__p11201105813241">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListPolicies__p32011358112416">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListPolicies__section3201115813244"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListPolicies__row320165813244"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListPolicies__p162028585244">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListPolicies__p1620217585243">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListPolicies__p19202115832419">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListPolicies__p4202145892411">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row19201115816241"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListPolicies__p182025585249">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListPolicies__p92021258182415">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListPolicies__p3202105818245">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListPolicies__p19202165812418">User token</p>
<p id="ListPolicies__p14202175842418">The token can be obtained by calling the IAM API used to obtain a user token. The value of <strong id="ListPolicies__b7202105811246">X-Subject-Token</strong> in the response header is the user token.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListPolicies__section82021458202417"><h4 class="sectiontitle">Response Parameters</h4><p id="ListPolicies__p1120215812415"><strong id="ListPolicies__b17202185818243">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_PolicyListResp" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListPolicies__row7203145814249"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListPolicies__p62031858102412">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListPolicies__p420325862411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListPolicies__p1920395812413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row13203145812410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListPolicies__p720375816245">policies</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListPolicies__p1120312583249">Array of <a href="#ListPolicies__response_Policy">Policy</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListPolicies__p9204155822410">Policy list</p>
</td>
</tr>
<tr id="ListPolicies__row3203105815245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListPolicies__p820445812245">count</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListPolicies__p14204258102418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListPolicies__p102041358152410">Total number of policies</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPolicies__response_Policy"></a><a name="response_Policy"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_Policy" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Policy</caption><thead align="left"><tr id="ListPolicies__row920455882413"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListPolicies__p1420518589243">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListPolicies__p42054586245">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListPolicies__p120520588243">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row9204165872417"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p7205135872416">enabled</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p7205165882413">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListPolicies__p0205185892415">Whether the policy is enabled</p>
</td>
</tr>
<tr id="ListPolicies__row4204105812246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p14205858142414">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p5206958172411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListPolicies__p13206175813244">Policy ID</p>
</td>
</tr>
<tr id="ListPolicies__row1204145820249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p9206135820247">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p1320665892413">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListPolicies__p82061258142411">Policy Name</p>
</td>
</tr>
<tr id="ListPolicies__row18204145822414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p1220605811246">operation_definition</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p420718586243"><a href="#ListPolicies__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="ListPolicies__p14207165842419">Policy attributes</p>
</td>
</tr>
<tr id="ListPolicies__row13204258172412"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p19207115802413">operation_type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p202085583243">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListPolicies__p19208105815241">Protection type, which can be <strong id="ListPolicies__b2208105882418">backup</strong> or <strong id="ListPolicies__b1620895814243">replication</strong></p>
<p id="ListPolicies__p1820885812418">Enumeration values:</p>
<ul id="ListPolicies__ul620885814247"><li id="ListPolicies__li1820845872413"><p id="ListPolicies__p5208175862420"><a name="ListPolicies__li1820845872413"></a><a name="li1820845872413"></a><strong id="ListPolicies__b22081758112411">backup</strong></p>
</li><li id="ListPolicies__li13208195812419"><p id="ListPolicies__p420810580241"><a name="ListPolicies__li13208195812419"></a><a name="li13208195812419"></a><strong id="ListPolicies__b172088582242">replication</strong></p>
</li></ul>
</td>
</tr>
<tr id="ListPolicies__row16204195816244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p8208195816241">trigger</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p1208458192417"><a href="#ListPolicies__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="ListPolicies__p12208758122410">Time scheduling rule for the policy</p>
</td>
</tr>
<tr id="ListPolicies__row62045588248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListPolicies__p132085586247">associated_vaults</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListPolicies__p112081058172416">Array of <a href="#ListPolicies__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="ListPolicies__p11208158112415">Associated vault</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPolicies__response_PolicyoODCreate"></a><a name="response_PolicyoODCreate"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_PolicyoODCreate" frame="border" border="1" rules="all"><caption><b>Table 6 </b>PolicyoODCreate</caption><thead align="left"><tr id="ListPolicies__row1209195812247"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="ListPolicies__p521014589245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="ListPolicies__p12210175813246">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="ListPolicies__p2021025819245">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row1320925882414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p22109582246">day_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p15210158152411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p521014589243">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="ListPolicies__b162109584248">max_backups</strong> will both be applied. The value ranges from <strong id="ListPolicies__b82106582247">0</strong> to <strong id="ListPolicies__b1210195816244">100</strong>. If this parameter is configured, <strong id="ListPolicies__b1121019585248">timezone</strong> is mandatory. This parameter and <strong id="ListPolicies__b1021015817249">retention_duration_days</strong> cannot be both applied.</p>
<p id="ListPolicies__p19210458172415">Minimum: <strong id="ListPolicies__b11210358172418">0</strong></p>
<p id="ListPolicies__p1921015812249">Maximum: <strong id="ListPolicies__b22101358132418">100</strong></p>
</td>
</tr>
<tr id="ListPolicies__row0209105811240"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p1821175817248">destination_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p1021111580248">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p13211105842413">ID of the replication destination project, which is mandatory for cross-region replication</p>
</td>
</tr>
<tr id="ListPolicies__row2020918586243"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p19211135842418">destination_region</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p721125810241">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p2021175810242">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="ListPolicies__row22091258162410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p121111582242">max_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p12111558172414">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p1221110580249">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="ListPolicies__p1721113586246">Minimum: <strong id="ListPolicies__b5211258192413">1</strong></p>
<p id="ListPolicies__p10211158102410">Maximum: <strong id="ListPolicies__b1821235818243">99999</strong></p>
<p id="ListPolicies__p621265814248">Default: <strong id="ListPolicies__b1421217584246">-1</strong></p>
</td>
</tr>
<tr id="ListPolicies__row1209155818248"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p521205822410">month_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p221245882411">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p521215892419">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="ListPolicies__b8212758182419">max_backups</strong> will both be applied. The value ranges from <strong id="ListPolicies__b221205812416">0</strong> to <strong id="ListPolicies__b14212558172415">100</strong>. If this parameter is configured, <strong id="ListPolicies__b821245814242">timezone</strong> is mandatory. This parameter and <strong id="ListPolicies__b3212858132410">retention_duration_days</strong> cannot be both applied.</p>
<p id="ListPolicies__p12121358182411">Minimum: <strong id="ListPolicies__b92121058192411">0</strong></p>
<p id="ListPolicies__p1921225852418">Maximum: <strong id="ListPolicies__b1212195819244">100</strong></p>
</td>
</tr>
<tr id="ListPolicies__row720915588246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p12128588244">retention_duration_days</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p7212145832413">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p8212058142418">Duration of retaining a backup, in days. The maximum value is <strong id="ListPolicies__b1521245862418">99999</strong>. If the value is set to <strong id="ListPolicies__b102121858122419">-1</strong>, backups will not be cleared by retention duration. If this parameter and <strong id="ListPolicies__b17212458162414">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="ListPolicies__b17212205852413">max_backups</strong>, <strong id="ListPolicies__b2021285819246">day_backups</strong>, <strong id="ListPolicies__b8212135813242">week_backups</strong>, <strong id="ListPolicies__b14212758142419">month_backups</strong>, and <strong id="ListPolicies__b162123580241">year_backups</strong>.</p>
<p id="ListPolicies__p6212258122414">Minimum: <strong id="ListPolicies__b82121558112411">1</strong></p>
<p id="ListPolicies__p721214580245">Maximum: <strong id="ListPolicies__b162124587249">99999</strong></p>
<p id="ListPolicies__p3212858172416">Default: <strong id="ListPolicies__b821225817241">-1</strong></p>
</td>
</tr>
<tr id="ListPolicies__row72091658162416"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p021395813242">timezone</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p0213105812242">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p2021355892420">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="ListPolicies__row152092058172419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p921335812411">week_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p10213658102420">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p1621314583241">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="ListPolicies__b92131358142412">max_backups</strong> will both be applied. The value ranges from <strong id="ListPolicies__b32131458162411">0</strong> to <strong id="ListPolicies__b6213258152410">100</strong>. If this parameter is configured, <strong id="ListPolicies__b1721317581241">timezone</strong> is mandatory. This parameter and <strong id="ListPolicies__b82135583243">retention_duration_days</strong> cannot be both applied.</p>
</td>
</tr>
<tr id="ListPolicies__row15209145852420"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="ListPolicies__p1921355811246">year_backups</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="ListPolicies__p112131558112418">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="ListPolicies__p3213165819245">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="ListPolicies__b721315588249">max_backups</strong> will both be applied. The value ranges from <strong id="ListPolicies__b5213558162415">0</strong> to <strong id="ListPolicies__b72139581245">100</strong>. If this parameter is configured, <strong id="ListPolicies__b92133582244">timezone</strong> is mandatory. This parameter and <strong id="ListPolicies__b19213158162414">retention_duration_days</strong> cannot be both applied.</p>
<p id="ListPolicies__p162131458192417">Minimum: <strong id="ListPolicies__b13213135820244">0</strong></p>
<p id="ListPolicies__p18213558122420">Maximum: <strong id="ListPolicies__b18213158192411">100</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPolicies__response_PolicyTriggerResp"></a><a name="response_PolicyTriggerResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_PolicyTriggerResp" frame="border" border="1" rules="all"><caption><b>Table 7 </b>PolicyTriggerResp</caption><thead align="left"><tr id="ListPolicies__row8214105842417"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListPolicies__p6214205832418">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListPolicies__p16214155872415">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListPolicies__p5214155832416">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row3214175812245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListPolicies__p17214135814243">id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListPolicies__p11215135822418">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListPolicies__p16215175813249">Scheduler ID</p>
</td>
</tr>
<tr id="ListPolicies__row02141558172419"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListPolicies__p1221511589242">name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListPolicies__p122151158122411">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListPolicies__p16215858132414">Scheduler name</p>
</td>
</tr>
<tr id="ListPolicies__row13214115814249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListPolicies__p22151358152420">properties</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListPolicies__p15215155811242"><a href="#ListPolicies__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="ListPolicies__p32161758162419">Scheduler attributes</p>
</td>
</tr>
<tr id="ListPolicies__row42140589244"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListPolicies__p821616588249">type</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListPolicies__p6217658132419">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListPolicies__p14217155818247">Scheduler type. Currently, only <strong id="ListPolicies__b14217175814243">time</strong> (periodic scheduling) is supported.</p>
<p id="ListPolicies__p19217175811246">Enumeration values:</p>
<ul id="ListPolicies__ul152171058132416"><li id="ListPolicies__li1421735842416"><p id="ListPolicies__p221710581242"><a name="ListPolicies__li1421735842416"></a><a name="li1421735842416"></a><strong id="ListPolicies__b321715882414">time</strong></p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPolicies__response_PolicyTriggerPropertiesResp"></a><a name="response_PolicyTriggerPropertiesResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_PolicyTriggerPropertiesResp" frame="border" border="1" rules="all"><caption><b>Table 8 </b>PolicyTriggerPropertiesResp</caption><thead align="left"><tr id="ListPolicies__row921755816242"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="ListPolicies__p14217105802413">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="ListPolicies__p2021795816247">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="ListPolicies__p1121875814247">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row62171558122414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListPolicies__p14218115832419">pattern</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListPolicies__p152187587249">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListPolicies__p921845819249">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="ListPolicies__b12182058102417">FREQ</strong>, <strong id="ListPolicies__b1921813589241">BYDAY</strong>, <strong id="ListPolicies__b17218558142415">BYHOUR</strong>, <strong id="ListPolicies__b6218145813246">BYMINUTE</strong>, and <strong id="ListPolicies__b1221810588247">INTERVAL</strong> parameters. <strong id="ListPolicies__b132181458162411">FREQ</strong> can be set only to <strong id="ListPolicies__b162181658142415">WEEKLY</strong> or <strong id="ListPolicies__b82184584249">DAILY</strong>. <strong id="ListPolicies__b11218105816240">BYDAY</strong> can be set to <strong id="ListPolicies__b17218175810245">MO</strong>, <strong id="ListPolicies__b15218135814242">TU</strong>, <strong id="ListPolicies__b221895832416">WE</strong>, <strong id="ListPolicies__b16218858182415">TH</strong>, <strong id="ListPolicies__b1218195872411">FR</strong>, <strong id="ListPolicies__b821885819246">SA</strong>, and <strong id="ListPolicies__b1321875852415">SU</strong> (seven days of a week). <strong id="ListPolicies__b721811585242">BYHOUR</strong> ranges from 0 to 23 hours. <strong id="ListPolicies__b10218658202416">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="ListPolicies__b421815812248">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="ListPolicies__b192181058102416">FREQ=DAILY;INTERVAL=1;BYHOUR=6;BYMINUTE=00</strong></p>
</td>
</tr>
<tr id="ListPolicies__row5217195822410"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="ListPolicies__p1621835802415">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="ListPolicies__p1921820583246">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="ListPolicies__p7218135812248">Start time of the scheduler, for example, <strong id="ListPolicies__b42188588242">2020-01-08 09:59:49</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListPolicies__response_PolicyAssociateVault"></a><a name="response_PolicyAssociateVault"></a><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__response_PolicyAssociateVault" frame="border" border="1" rules="all"><caption><b>Table 9 </b>PolicyAssociateVault</caption><thead align="left"><tr id="ListPolicies__row72181858162419"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListPolicies__p221918584245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListPolicies__p17219195892418">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListPolicies__p1821995810247">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row17219175820247"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListPolicies__p1721925817246">destination_vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListPolicies__p142196585246">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListPolicies__p521975822418">ID of the associated remote vault</p>
</td>
</tr>
<tr id="ListPolicies__row1821914587245"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListPolicies__p2219205882419">vault_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListPolicies__p11219195812246">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListPolicies__p02203588241">Vault ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListPolicies__section1022012589246"><h4 class="sectiontitle">Example Requests</h4><pre class="screen" id="ListPolicies__screen1022045813243">GET https://{endpoint}/v3/{project_id}/policies</pre>
</div>
<div class="section" id="ListPolicies__section192207580245"><h4 class="sectiontitle">Example Responses</h4><p id="ListPolicies__p152206580243"><strong id="ListPolicies__b14220165842416">Status code: 200</strong></p>
<p id="ListPolicies__p42201258162417">OK</p>
<pre class="screen" id="ListPolicies__screen322025862420">{
"policies" : [ {
"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"
} ],
"count" : 10
}</pre>
</div>
<div class="section" id="ListPolicies__section345885811247"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListPolicies__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListPolicies__row132241158142415"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListPolicies__p1345910585249">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListPolicies__p645935820243">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListPolicies__row18224158132410"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListPolicies__p8459658192415">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListPolicies__p20459758192418">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListPolicies__section1045955892418"><h4 class="sectiontitle">Error Codes</h4><p id="ListPolicies__p445995812248">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