doc-exports/docs/obs/umn/obs_03_0718.html

<a name="obs_03_0718"></a><a name="obs_03_0718"></a>

<h1 class="topictitle1">Configuring WORM Retention</h1>
<div id="body0000001504144984"><p id="obs_03_0718__p67621125195716">You can determine whether to enable WORM when creating a bucket. For details, see <a href="obs_03_0306.html">Creating a Bucket</a>. When creating a bucket, if you enable WORM, you can continue to configure WORM after the bucket is created; if you do not enable it, you are not allowed to enable or configure it for that bucket later.</p>
<p id="obs_03_0718__p616010491055">The following describes how to configure WORM retention after you create a bucket with WORM enabled.</p>
<div class="section" id="obs_03_0718__section20757205117354"><h4 class="sectiontitle">Prerequisites</h4><p id="obs_03_0718__p3411151418360">You have enabled WORM for the bucket when you create it.</p>
</div>
<div class="section" id="obs_03_0718__section7719858114812"><h4 class="sectiontitle">Configuring WORM for a Bucket</h4><ol id="obs_03_0718__ol813010594368"><li id="obs_03_0718__li11242915363"><span>In the bucket list, click the bucket you want to operate to go to the <strong id="obs_03_0718__obs_03_0307_b5948183711913">Objects</strong> page.</span></li><li id="obs_03_0718__li15832125015014"><span>In the navigation pane, choose <strong id="obs_03_0718__obs_03_0143_b4304113864518">Overview</strong>.</span></li><li id="obs_03_0718__li18830181855820"><span>In the <strong id="obs_03_0718__b6651205934015">Basic Configurations</strong> area, click <strong id="obs_03_0718__b34241933152118">WORM Retention</strong>. The <strong id="obs_03_0718__b107200129223">Configure WORM Retention</strong> dialog box is displayed.</span></li><li id="obs_03_0718__li185861427134716"><span>Choose <strong id="obs_03_0718__b17505143172518">Configure</strong>. Keep the default <strong id="obs_03_0718__b16406192902619">Compliance</strong> retention mode and specify a default retention period.</span><p><div class="note" id="obs_03_0718__note13940191325914"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="obs_03_0718__ul74611730165910"><li id="obs_03_0718__li1930710365595">Only the compliance retention mode is currently supported. In this mode, no users can delete protected object versions or change their retention mode during the specified retention period.</li><li id="obs_03_0718__li5462230105919">During the specified default retention period, OBS prevents WORM-protected object versions from being deleted. You can configure a retention period in either days (from <strong id="obs_03_0718__b1549412164400">1</strong> to <strong id="obs_03_0718__b12248187406">36500</strong>) or years (from <strong id="obs_03_0718__b203257210408">1</strong> to <strong id="obs_03_0718__b1449152311405">100</strong>). The upper limit is 100 years.</li><li id="obs_03_0718__li2044514312395">When you upload an object to a WORM-protected bucket, the object inherits the WORM retention from the bucket by default. You can also configure a different WORM retention for the object under advanced settings. If both a bucket-level and object-level WORM retention policy are applied to an object, the object-level retention policy will be used.</li></ul>
</div></div>
<div class="fignone" id="obs_03_0718__fig94754234273"><span class="figcap"><b>Figure 1 </b>Configuring a WORM retention policy</span><br><span><img id="obs_03_0718__image947514232272" src="en-us_image_0000001953176333.png" title="Click to enlarge" class="imgResize"></span></div>
</p></li><li id="obs_03_0718__li588417556593"><span>Click <strong id="obs_03_0718__b158188833215">OK</strong>.</span></li></ol>
</div>
<div class="section" id="obs_03_0718__section97201658184816"><h4 class="sectiontitle">Skipping the WORM Retention Configuration</h4><ol id="obs_03_0718__ol2305415123712"><li id="obs_03_0718__li133617442311"><span>In the bucket list, click the bucket you want to operate to go to the <strong id="obs_03_0718__obs_03_0307_b5948183711913_1">Objects</strong> page.</span></li><li id="obs_03_0718__li3944340132320"><span>In the navigation pane, choose <strong id="obs_03_0718__obs_03_0143_b4304113864518_1">Overview</strong>.</span></li><li id="obs_03_0718__li11336244153118"><span>In the <strong id="obs_03_0718__b1288714005615">Basic Configurations</strong> area, click <strong id="obs_03_0718__b7887104014568">WORM Retention</strong>. The <strong id="obs_03_0718__b18887240185610">Configure WORM Retention</strong> dialog box is displayed.</span></li><li id="obs_03_0718__li18336114433120"><span>Choose <strong id="obs_03_0718__b84235270617293">Skip</strong>.</span><p><div class="fignone" id="obs_03_0718__fig259313815302"><span class="figcap"><b>Figure 2 </b>Skipping the WORM retention configuration</span><br><span><img id="obs_03_0718__image959316386302" src="en-us_image_0000001953342509.png" title="Click to enlarge" class="imgResize"></span></div>
</p></li><li id="obs_03_0718__li11775193842916"><span>Click <strong id="obs_03_0718__b188271623204717">OK</strong>.</span></li></ol>
</div>
<div class="section" id="obs_03_0718__section13387135815274"><h4 class="sectiontitle">Extending the Retention Period</h4><p id="obs_03_0718__p15661521">After WORM is configured for an object, you can extend the retention period of an object version. Before the specified date, OBS prevents protected object versions from being deleted.</p>
<ol id="obs_03_0718__ol1334083111349"><li id="obs_03_0718__li6429131612215"><span>In the bucket list, click the bucket you want to operate to go to the <strong id="obs_03_0718__obs_03_0307_b5948183711913_2">Objects</strong> page.</span></li><li id="obs_03_0718__li10400184575518"><span>Locate the object version for which you want to extend the retention period, choose <strong id="obs_03_0718__b151671438201311">More</strong> &gt; <strong id="obs_03_0718__b127315491362">Extend Retention Period</strong>, and select a date.</span><p><div class="fignone" id="obs_03_0718__fig150316412340"><span class="figcap"><b>Figure 3 </b>Extending the retention period</span><br><span><img id="obs_03_0718__image1350374113341" src="en-us_image_0000001953346977.png" title="Click to enlarge" class="imgResize"></span></div>
<div class="note" id="obs_03_0718__note293310101917"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0718__p73611946161912">A retention period can be extended, but cannot be shortened.</p>
<p id="obs_03_0718__p79331016198">Assume that an object version was configured to be protected until March 30, 2023. If you want to extend the retention period on March 1, 2023, you can extend it to March 31, 2023 or a later date. If you extend the retention period on April 1, 2023, you can extend it to the current day (April 1, 2023) or a later date. If the current day is used, the object version will no longer be protected by WORM after 24:00 on that day.</p>
</div></div>
</p></li></ol>
</div>
<div class="section" id="obs_03_0718__section335018186586"><h4 class="sectiontitle">Manually and Permanently Deleting Objects from a WORM-Enabled Bucket</h4><p id="obs_03_0718__p167740510323">In the <strong id="obs_03_0718__b240719634518">Deleted Objects</strong> list, objects cannot be permanently deleted from a WORM-enabled bucket. In a WORM-enabled bucket, if an object has no retention policy configured or its retention policy has expired, you can manually delete a desired object version. If the object version is within the retention period, it cannot be deleted.</p>
<ol id="obs_03_0718__ol16991122214112"><li id="obs_03_0718__li1140153142913"><span>In the bucket list, click the bucket you want to operate to go to the <strong id="obs_03_0718__obs_03_0307_b5948183711913_3">Objects</strong> page.</span></li><li id="obs_03_0718__li33155225302"><span>Enable <strong id="obs_03_0718__b3288225131417">Historical Versions</strong>.</span></li><li id="obs_03_0718__li145583712302"><span>Select the object version to be permanently deleted and click <strong id="obs_03_0718__b48541745102614">Permanently Delete</strong> above the search bar.</span></li><li id="obs_03_0718__li7679230133114"><span>Click <strong id="obs_03_0718__b15271181715274">OK</strong>.</span></li></ol>
</div>
<div class="section" id="obs_03_0718__section579615313018"><h4 class="sectiontitle">Using a Lifecycle Rule to Delete Objects from a WORM-Enabled Bucket</h4><p id="obs_03_0718__p1998416352712">You can configure a lifecycle rule to let OBS automatically expire and delete objects in a WORM enabled bucket. To realize this, the objects must have no retention policies configured or their retention policies have expired. If the objects are within their retention period, they cannot be deleted.</p>
<div class="note" id="obs_03_0718__note20658194718527"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0718__p965834735210">In a WORM-enabled bucket, folders cannot be permanently deleted from the <strong id="obs_03_0718__b1921828161710">Deleted Objects</strong> list. To permanently delete a folder, you can only configure a lifecycle rule.</p>
</div></div>
<ol id="obs_03_0718__ol247710012116"><li id="obs_03_0718__li2570212173419"><span>In the bucket list, click the bucket you want to operate to go to the <strong id="obs_03_0718__obs_03_0307_b5948183711913_4">Objects</strong> page.</span></li><li id="obs_03_0718__li4270182113338"><span>In the navigation pane, choose <strong id="obs_03_0718__b854981021518">Data Management</strong> &gt; <strong id="obs_03_0718__b2054981017156">Lifecycle Rules</strong>.</span></li><li id="obs_03_0718__li6653363119435"><span>Click <strong id="obs_03_0718__b5981655194120">Create</strong>.</span></li><li id="obs_03_0718__li39098515"><span>Configure a lifecycle rule.</span><p><div class="p" id="obs_03_0718__p5509517915252">Configure parameters under <strong id="obs_03_0718__b15669118143116">Basic Information</strong>:<ul id="obs_03_0718__ul16342320"><li id="obs_03_0718__li12863160"><strong id="obs_03_0718__b58261618163518">Status</strong>: Select <strong id="obs_03_0718__b108264180355">Enable</strong> to enable this lifecycle rule after the configuration.</li><li id="obs_03_0718__li529954661965"><strong id="obs_03_0718__b095462273517">Rule Name</strong>: It identifies a lifecycle rule. The rule name must be no longer than 255 characters.</li><li id="obs_03_0718__li73051556987"><strong id="obs_03_0718__b211159184514">Prefix</strong>: It is optional.<ul id="obs_03_0718__ul114912410811"><li id="obs_03_0718__li6149164119813">If this field is configured, objects with the specified prefix will be managed by the lifecycle rule. The prefix cannot start with a slash (/) or contain two consecutive slashes (//), and cannot contain the following special characters: \:*?"&lt;&gt;|</li><li id="obs_03_0718__li21491041582">If this field is not configured, all objects in the bucket will be managed by the lifecycle rule.</li></ul>
</li></ul>
</div>
<p id="obs_03_0718__p4329302814373">Configure parameters under <strong id="obs_03_0718__b158295403310">Current Version</strong> or <strong id="obs_03_0718__b19829134033119">Historical Version</strong>:</p>
<p id="obs_03_0718__p20629144611155"><strong id="obs_03_0718__b768152617471">Delete Objects After (Days)</strong>: After this number of days since the last update, OBS will expire and then delete the objects meeting the specified conditions. The days set here must be larger than any of the days configured for the transition actions.</p>
<div class="p" id="obs_03_0718__p50988061113345">Suppose that you last updated the following files in OBS on November 7, 2023:<ul id="obs_03_0718__ul466294043312"><li id="obs_03_0718__li28459613"><strong id="obs_03_0718__b14607101920382">log/notConfigured-1.log</strong> (This file has no WORM retention policy configured.)</li><li id="obs_03_0718__li54809927"><strong id="obs_03_0718__b7799183510384">log/expired-1.log</strong> (The WORM retention policy configured for this file has expired.)</li><li id="obs_03_0718__li23527303"><strong id="obs_03_0718__b6800143419394">doc/withinRetention-1.doc</strong> (The WORM retention policy configured for this file expires on November 30, 2023.)</li></ul>
</div>
<div class="MsoNormal" id="obs_03_0718__p26663410">Then on November 10, 2023, you last updated the following files:<ul id="obs_03_0718__ul1877348103412"><li id="obs_03_0718__li12252614"><strong id="obs_03_0718__b11764194215406">log/notConfigured-2.log</strong> (This file has no WORM retention policy configured.)</li><li id="obs_03_0718__li43164662"><strong id="obs_03_0718__b5884135324014">log/expired-2.log</strong> (The WORM retention policy configured for this file has expired.)</li><li id="obs_03_0718__li52937641"><strong id="obs_03_0718__b354611134118">doc/withinRetention-2.doc</strong> (The WORM retention policy configured for this file expires on November 30, 2023.)</li></ul>
</div>
<p id="obs_03_0718__p513573918258">On November 10, 2023, you set the objects prefixed with <strong id="obs_03_0718__b3202712124117">log</strong> to expire one day later. You might encounter the following situations:</p>
<ul id="obs_03_0718__ul144381629142811"><li id="obs_03_0718__li16278121835914">Objects <strong id="obs_03_0718__b9235938174313">log/notConfigured-1.log</strong> and <strong id="obs_03_0718__b32351838114320">log/expired-1.log</strong> last updated on November 7, 2023 might be deleted after the last system scan. The deletion could happen on November 10, 2023 or November 11, 2023, depending on the time of the last system scan. <strong id="obs_03_0718__b1296033674416">doc/withinRetention-1.doc</strong> will not be deleted.</li><li id="obs_03_0718__li55721128513">Objects <strong id="obs_03_0718__b1932735319220">log/notConfigured-2.log</strong> and <strong id="obs_03_0718__b53279533220">log/expired-2.log</strong> last uploaded on November 10, 2023 might be deleted on November 11, 2023 or November 12, 2023, depending on whether they have been stored for over one day (since their last update) when the system scan happened. <strong id="obs_03_0718__b128918914489">doc/withinRetention-2.doc</strong> will not be deleted.</li></ul>
<div class="note" id="obs_03_0718__note146711757155810"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="obs_03_0718__p28814114262">For more information about how to configure lifecycle rules, see <a href="obs_03_0335.html">Configuring a Lifecycle Rule</a>.</p>
</div></div>
</p></li><li id="obs_03_0718__li56738760"><span>Click <strong id="obs_03_0718__b974116258618">OK</strong>.</span></li></ol>
</div>
<div class="section" id="obs_03_0718__section106645237245"><h4 class="sectiontitle">Related Operations</h4><p id="obs_03_0718__p11952134132419">When uploading an object, configure a retention policy for the object. For details, see <a href="en-us_topic_0045853663.html">Uploading an Object</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="obs_03_0717.html">WORM</a></div>
</div>
</div>


<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>