On this page

Functions
Request Syntax
Request Parameters
Request Headers
Request Elements
Response Syntax
Response Headers
Response Elements
Error Responses
Sample Request
Sample Response

Show all

Help Center/ Object Storage Service/ API Reference (Ankara Region)/ APIs/ Advanced Bucket Settings/ Configuring Bucket Lifecycle Rules

Configuring Bucket Lifecycle Rules

Updated on 2024-04-15 GMT+08:00

View PDF

Functions

This operation configures lifecycle rules that can delete objects from a bucket at a specified time. Typical application scenarios:

Delete periodically uploaded files. Some files uploaded periodically need only to be retained for only one week or one month.
Delete files that are frequently accessed within a certain period of time but are seldom accessed afterward. You can archive these files and then schedule the time for deletion.

You can perform this operation to create or update the lifecycle configuration of a bucket.

NOTE:

Expired objects deleted based on a lifecycle rule cannot be recovered.

To perform this operation, you must have the PutLifecycleConfiguration permission. By default, only the bucket owner can perform this operation. The bucket owner can grant the permission to other users by configuring the bucket policy or user policy.

The lifecycle configuration enables OBS to delete objects at a scheduled time. To prevent a user from doing so, the following permissions granted to the user must be revoked:

DeleteObject
DeleteObjectVersion
PutLifecycleConfiguration

If you want to forbid a user to set the bucket lifecycle configuration, revoke the PutLifecycleConfiguration permission from the user.

Request Syntax

    
     
       
       PUT /?lifecycle HTTP/1.1 
Host: bucketname.obs.region.example.com
Content-Length: length
Date: date
Authorization: authorization
Content-MD5: MD5
<?xml version="1.0" encoding="UTF-8"?> 
<LifecycleConfiguration> 
    <Rule> 
        <ID>id</ID> 
        <Prefix>prefix</Prefix> 
        <Status>status</Status> 
        <Expiration> 
            <Days>days</Days> 
        </Expiration> 
        <NoncurrentVersionExpiration> 
            <NoncurrentDays>days</NoncurrentDays> 
        </NoncurrentVersionExpiration> 
    </Rule> 
</LifecycleConfiguration>

      

    
   

Request Parameters

This request contains no parameters.

Request Headers

Table 1 lists the request header.

**Table 1** Request headers
Header	Description	Mandatory
Content-MD5	Base64-encoded 128-bit MD5 digest of the message according to RFC 1864. Type: string Example: n58IG6hfM7vqI4K0vnWpog==	Yes

Request Elements

In this request body, you need to specify the lifecycle configuration in XML format. Table 2 describes the specific configuration elements.

If the versioning of a bucket is enabled or suspended, you can set NoncurrentVersionExpiration to control the lifecycle of historical object versions. The lifecycle of a historical version depends on the time when it becomes a historical one (time when the version is replaced by a new version) and the value of NoncurrentDays. If NoncurrentDays is set to 1, an object version will be deleted one day after it becomes historical. If the version V1 of object A is created on the first date of a month and new version V2 is uploaded on the fifth date of the month, V1 becomes a historical version. At 00:00 on the seventh date of the month, V1 will expire. The deletion of the object after the expiration time may be delayed. The delay is within 48 hours.
Objects are processed according to the following procedures, if their latest versions meet the expiration rule and versioning is enabled or suspended for the bucket.
- Versioning enabled:
  If the latest object version is not a delete marker, a new delete marker will be inserted for the object.
  
  If the latest object version is a delete marker and is the only version of the object, this latest version will be deleted.
  
  If the object of the latest version has the DeleteMarker and the object has other versions, all versions of the object remain unchanged.
- Versioning suspended:
  If the latest version of the object does not have the DeleteMarker and is not the null version, the object generates a new DeleteMarker for the null version.
  
  If the latest version of the object does not have the DeleteMarker but is the null version, this null version is overwritten by a new DeleteMarker generated for the null version.
  
  If the latest object version is a delete marker and is the only version of the object, this latest version will be deleted.
  
  If the object of the latest version has the DeleteMarker and the object has other versions, all versions of the object remain unchanged.

**Table 2** Response elements for lifecycle configuration
Name	Description	Mandatory
Date	Specifies that OBS executes lifecycle rules for objects before the specified date. The date must be compliant with the ISO8601 format, and the time must be compliant with the UTC format of 00:00:00. For example, 2018-01-01T00:00:00.000Z indicates that objects whose last modification time is earlier than 2018-01-01T00:00:00.000Z are deleted. Objects whose last modification time is equal to or later than the specified time are not deleted. Type: string Parent: Expiration	Required if the Days element is absent.
Days	Specifies the number of days (since the latest update to the latest object version) after which the lifecycle rule takes effect. Type: integer Parent: Expiration	Required if the Date element is absent.
Expiration	Container for the object expiration rule (only applicable to the latest versions of objects). Type: XML Child: Date or Days Parent: Rule	Yes
ID	Unique identifier of a rule. The value can contain a maximum of 255 characters. Type: string Parent: Rule	No
LifecycleConfiguration	Container for lifecycle rules. You can add multiple rules. The total size of the rules cannot exceed 20 KB. Type: XML Child: Rule Parent: none	Yes
NoncurrentDays	Number of days when the specified rule takes effect after the object becomes a historical version (only applicable to an object's historical version). Type: integer Parent: NoncurrentVersionExpiration	Required if the NoncurrentVersionExpiration element is present.
NoncurrentVersionExpiration	Container for the expiration time of objects' historical versions. If versioning is enabled or suspended for a bucket, you can set NoncurrentVersionExpiration to delete historical versions of objects that match the lifecycle rule (only applicable to the historical versions of objects). Type: XML Child: NoncurrentDays Parent: Rule	No
Prefix	Object name prefix that identifies one or more objects to which the rule applies. Type: string Parent: Rule Constraints: When you configure a lifecycle rule by specifying a prefix, if the specified prefix and the prefix of an existing lifecycle rule overlap, OBS regards these two rules as one and forbids you to configure this rule. For example, if there is a rule with the object prefix abc configured in the system, another rule with the object prefix starting with abc cannot be configured. If there is already a lifecycle rule that is based on an object prefix, you are not allowed to configure another rule that is applied to the entire bucket.	Yes
Rule	Container for a specific lifecycle rule. Type: container Parent: LifecycleConfiguration	Yes
Status	Indicates whether the rule is enabled. Type: string Parent: Rule Value options: Enabled, Disabled	Yes

Response Syntax

    
       HTTP/1.1 status_code
Date: date
Content-Length: length

Response Headers

The response to the request uses common headers. For details, see Table 1.

Response Elements

This response contains no elements.

Error Responses

No special error responses are returned. For details about error responses, see Table 2.

Sample Request

    
     
       
       PUT /?lifecycle HTTP/1.1
User-Agent: curl/7.29.0
Host: examplebucket.obs.region.example.com
Accept: */*
Date: WED, 01 Jul 2015 03:05:34 GMT
Authorization: OBS H4IPJX0TQTHTHEBQQCEC:DpSAlmLX/BTdjxU5HOEwflhM0WI=
Content-MD5: ujCZn5p3fmczNiQQxdsGaQ==
Content-Length: 919

<?xml version="1.0" encoding="utf-8"?>
<LifecycleConfiguration> 
  <Rule> 
    <ID>delete-2-days</ID>  
    <Prefix>test/</Prefix>  
    <Status>Enabled</Status>  
    <Expiration> 
      <Days>70</Days> 
    </Expiration>  
    <NoncurrentVersionExpiration> 
      <NoncurrentDays>70</NoncurrentDays> 
    </NoncurrentVersionExpiration>
  </Rule>
</LifecycleConfiguration>

      

    
   

Sample Response

    
       HTTP/1.1 200 OK
Server: OBS
x-obs-request-id: BF26000001643670AC06E7B9A7767921
x-obs-id-2: 32AAAQAAEAABSAAgAAEAABAAAQAAEAABCSvK6z8HV6nrJh49gsB5vqzpgtohkiFm
Date: WED, 01 Jul 2015 03:05:34 GMT
Content-Length: 0

Parent topic: Advanced Bucket Settings

Previous topic: Obtaining a Bucket Logging Configuration

Next topic: Obtaining Bucket Lifecycle Configuration

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot