Object Storage Service:Configure lifecycle rules

1. Log on to the OSS console.

2. In the left-side navigation pane, choose Data Service > OSS on CloudBox Buckets.

3. Click the OSS on CloudBox bucket for which you want to configure lifecycle rules.

4. In the left-side navigation tree, choose Data Management > Lifecycle.

5. On the Lifecycle page, click Create Rule and configure the parameters. For unversioned buckets, configure the following parameters: For versioning-enabled buckets, configure the Basic Settings and Delete Parts sections the same way as for unversioned buckets. The following parameters differ:

   Important

   Each lifecycle rule must include at least one of: an object expiration policy or a part expiration policy.

   Note

   The previous version expiration period starts from the last modified time of the next version—not from when the object was originally created.

   Section	Parameter	Description
   Basic Settings	Status	Enable or disable the rule. Valid values: Enabled, Disabled
   Basic Settings	Applied To	Scope of the rule. Select Files with Specified Prefix to apply the rule to objects matching a prefix, or Whole Bucket to apply it to all objects
   Basic Settings	Prefix	The prefix to match. For example, enter img to apply the rule to all objects whose names start with img. Required when Applied To is set to Files with Specified Prefix
   Clear Policy	Object Lifecycle	When objects expire. Valid values: Validity Period (Days), Expiration Date, Disabled. Select Disabled to skip object expiration
   Clear Policy	Delete	When enabled, expired objects are automatically deleted and cannot be recovered
   Delete Parts	Part Lifecycle	When parts expire. Valid values: Validity Period (Days), Expiration Date, Disabled. Select Disabled to skip part expiration
   Delete Parts	Delete	When enabled, expired parts are automatically deleted and cannot be recovered

   Section	Parameter	Description
   Current Version	Removal of Delete Marker	When enabled (Clean Up Delete Marker), OSS removes a delete marker only if it is the sole remaining version of an object. If the object has multiple versions and the current version is a delete marker, OSS retains it. See Delete marker
   Previous Versions	Object Lifecycle	When previous versions expire. Valid values: Validity Period (Days), Disabled
   Previous Versions	Delete	The number of days a previous version is retained before deletion. For example, with a validity period of 30 days, an object that became a previous version on September 1, 2021 is deleted on October 1, 2021

OSS SDK for Java version 3.15.0 or later is required to configure lifecycle rules for an OSS on CloudBox bucket.

The following example creates a lifecycle rule (rule0) that expires all objects in the bucket 3 days after they are last modified, then queries the configured rules.

import com.aliyun.oss.ClientException;
import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClientBuilder;
import com.aliyun.oss.OSSException;
import com.aliyun.oss.model.LifecycleRule;
import com.aliyun.oss.model.SetBucketLifecycleRequest;
import java.util.List;
import com.aliyun.oss.common.auth.DefaultCredentialProvider;
import com.aliyun.oss.common.comm.SignVersion;
import com.aliyun.oss.ClientBuilderConfiguration;
import com.aliyun.oss.common.auth.CredentialsProviderFactory;
import com.aliyun.oss.common.auth.EnvironmentVariableCredentialsProvider;

public class Demo {

    public static void main(String[] args) throws Exception {
        // Endpoint of the OSS on CloudBox bucket
        String endpoint = "https://cb-f8z7yvzgwfkl9q0h****.cn-hangzhou.oss-cloudbox.aliyuncs.com";
        // Load credentials from environment variables OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET
        EnvironmentVariableCredentialsProvider credentialsProvider =
            CredentialsProviderFactory.newEnvironmentVariableCredentialsProvider();
        // Name of the OSS on CloudBox bucket, e.g., examplebucket
        String bucketName = "examplebucket";
        // Region where the OSS on CloudBox bucket is located
        String region = "cn-hangzhou";
        // ID of the cloud box
        String cloudBoxId = "cb-f8z7yvzgwfkl9q0h****";

        ClientBuilderConfiguration conf = new ClientBuilderConfiguration();
        conf.setSignatureVersion(SignVersion.V4);
        OSS ossClient = OSSClientBuilder.create()
                .endpoint(endpoint)
                .credentialsProvider(new DefaultCredentialProvider(credentialsProvider.getCredentials()))
                .clientConfiguration(conf)
                .region(region)
                .build();

        try {
            SetBucketLifecycleRequest request = new SetBucketLifecycleRequest(bucketName);

            String ruleId0 = "rule0";
            // Null prefix: the rule applies to all objects in the bucket
            String matchPrefix0 = null;

            // Expire objects 3 days after last modification
            LifecycleRule rule = new LifecycleRule(ruleId0, matchPrefix0, LifecycleRule.RuleStatus.Enabled, 3);
            request.AddLifecycleRule(rule);

            ossClient.setBucketLifecycle(request);

            // Query the configured lifecycle rules
            List<LifecycleRule> listRules = ossClient.getBucketLifecycle(bucketName);
            for (LifecycleRule rules : listRules) {
                System.out.println("ruleId=" + rules.getId()
                    + ", matchPrefix=" + rules.getPrefix()
                    + ", expirationDays=" + rules.getExpirationDays());
            }
        } catch (OSSException oe) {
            System.out.println("OSS error: " + oe.getErrorMessage()
                + " (Code: " + oe.getErrorCode()
                + ", RequestId: " + oe.getRequestId() + ")");
        } catch (ClientException ce) {
            System.out.println("Client error: " + ce.getMessage());
        } finally {
            if (ossClient != null) {
                ossClient.shutdown();
            }
        }
    }
}

Before running the code, set the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables to your Alibaba Cloud credentials, and replace the following placeholders:

See put-bucket-lifecycle for the ossutil command reference.

For direct API calls, see PutBucketLifecycle. Direct API calls require you to handle signature calculation in your code.