Configuring Bucket Lifecycle Rules

Content-SHA256

Yes

String

Definition:

SHA-256 digest string of the message body, that is, the string obtained after the 256-bit SHA-256 value of the message body is encoded using Base64

Example: ogX9qClMrVJUBiUSIKDFM0qO41jJM0I5SCN55/OtMyI=

Range:

None

Default value:

None

LifecycleConfiguration

Yes

XML

Definition:

Lifecycle rules. Multiple rules can be configured. LifecycleConfiguration is the parent node of Rule.

Constraints:

The total size of the configuration message body cannot exceed 20 KB.

Range:

None

Default value:

None

Rule

Yes

XML

Definition:

A specific lifecycle rule.

Constraints:

None

Range:

For details, see Table 3.

Default value:

None

Transition

Yes if the NoncurrentVersionTransition, Expiration, AbortIncompleteMultipartUpload, and NoncurrentVersionExpiration elements are absent.

XML

Definition:

Transition time and the object storage class after transition

Constraints:

This parameter is only available for the latest object version.

Range:

For details, see Table 4.

Default value:

None

Expiration

Yes if Transition, NoncurrentVersionTransition, AbortIncompleteMultipartUpload, and NoncurrentVersionExpiration are absent.

XML

Definition:

Expiration time.

Constraints:

This parameter is only available for the latest object version.

Range:

For details, see Table 5.

Default value:

None

NoncurrentVersionTransition

Yes if the Transition, Expiration, AbortIncompleteMultipartUpload, and NoncurrentVersionExpiration elements are absent.

XML

Definition:

Transition time and the object storage class after transition

Constraints:

This parameter is only available for historical object versions.

Range:

For details, see Table 6.

Default value:

None

NoncurrentVersionExpiration

No

XML

Definition:

Expiration time of objects' historical versions. If versioning is enabled or suspended for a bucket, you can set this parameter to delete historical versions of objects that match the lifecycle rule.

Constraints:

This parameter is only available for historical object versions.

Range:

For details, see Table 7.

Default value:

None

AbortIncompleteMultipartUpload

Yes if the Transition, Expiration, NoncurrentVersionExpiration, and NoncurrentVersionTransition elements are absent.

XML

Definition:

Expiration attribute of fragments in an unassembled multipart task.

Constraints:

Tag-based filtering is not supported.

Range:

For details, see Table 8.

Default value:

None

Filter

Either Filter or Prefix can be configured at the same level under Rule. Prefix can be a child node of Filter.

XML

Definition:

A specific filter. The lifecycle rule will apply to the objects matching this filter in a bucket. You can filter objects by object name prefix, object tag, or a combination of them.

Constraints:

If there are multiple filtering criteria, use the AND logic to combine them.

Range:

For details, see Table 9.

Default value:

None

ID

No

String

Definition:

ID of a rule.

Constraints:

Only letters, digits, periods (.), underscores (_), and hyphens (-) are allowed.

Range:

The value is a string of 0 to 255 characters.

Default value:

None

Prefix

Yes

String

Definition:

Object name prefix. It identifies the objects the rule applies to.

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.

Range:

The value is a string of 0 to 255 characters.

Default value:

None

Status

Yes

String

Definition:

Whether the rule is enabled

Constraints:

None

Range:

• Enabled: The rule is enabled.
• Disabled: The rule is disabled.

Default value:

None

Date

Yes if the Days element is absent.

String

Definition:

Specifies that OBS executes lifecycle rules for objects before the specified date.

Constraints:

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 or transitioned to another storage class. Objects whose last modification time is equal to or later than the specified time are not deleted or transitioned to another storage class.

Range:

Character string in the date format.

Default value:

None

Days

Yes if the Date element is absent.

Integer

Definition:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

Constraints:

This parameter is only available for the latest object version.

Range:

The value is an integer ranging from 0 to 2147483647.

Default value:

None

StorageClass

Yes if the Transition or NoncurrentVersionTransition element is present.

String

Definition:

The storage class to which the object is transitioned.

Constraints:

None

Range:

• WARM: Infrequent Access storage class
• COLD: Archive storage class
• DEEP_ARCHIVE: Deep Archive storage class

Default value:

None

Date

Yes if the Days element is absent.

String

Definition:

Specifies that OBS executes lifecycle rules for objects before the specified date.

Constraints:

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 or transitioned to another storage class. Objects whose last modification time is equal to or later than the specified time are not deleted or transitioned to another storage class.

Range:

Character string in the date format.

Default value:

None

Days

Yes if the Date element is absent.

Integer

Definition:

Number of days (since the last update was made to the object) after which the lifecycle rule takes effect

Constraints:

This parameter is only available for the latest object version.

Range:

The value is an integer ranging from 0 to 2147483647.

Default value:

None

NoncurrentDays

Yes if the NoncurrentVersionExpiration or NoncurrentVersionTransition element is present.

Integer

Definition:

Number of days an object is historical before the specified rule takes effect

Constraints:

This parameter is only available for historical object versions.

Range:

• If only one transition is involved, the time should be at least one day later.
• If multiple transitions are involved, the latter transition should be at least one day later than the former transition.
• Multiple transitions: For the same object, the time its historical versions transition to the Deep Archive storage class must be later than the time they transition to the Archive storage class, and the time of transitioning to the Archive storage class must be later than the time of transitioning to the Infrequent Access storage class.

Default value:

None

StorageClass

Yes if the Transition or NoncurrentVersionTransition element is present.

String

Definition:

The storage class to which the object is transitioned.

Constraints:

None

Range:

• WARM: Infrequent Access storage class
• COLD: Archive storage class
• DEEP_ARCHIVE: Deep Archive storage class

Default value:

None

NoncurrentDays

Yes if the NoncurrentVersionExpiration or NoncurrentVersionTransition element is present.

Integer

Definition:

Number of days an object is historical before the specified rule takes effect

Constraints:

This parameter is only available for historical object versions.

Range:

The value is an integer ranging from 0 to 2147483647.

Default value:

None

DaysAfterInitiation

Yes if the AbortIncompleteMultipartUpload element is present.

Integer

Definition:

Number of days fragments are present before being deleted

Constraints:

None

Range:

The value is an integer ranging from 0 to 2147483647.

Default value:

None

And

Yes if there are multiple Prefix and Tag rules.

XML

Definition:

The And logic among filtering criteria. The And logic can be used when both the object name prefix and object tag are used or multiple object tags are used.

Constraints:

• And must have child nodes.
• If Filter has Tag or Prefix as its child node, And cannot be a child node at the same level as the Tag or Prefix child node under Filter. (Tag and Prefix can be included in And.)

Range:

For details, see Table 10.

Default value:

None

Tag

No

Container

Definition:

Object tag, which is used to identify what objects match the rule.

Constraints:

• If Tag is configured as a child node of Filter, there can be only one Tag node. If Filter has a Prefix child node, there cannot be any Tag node at the same level with Prefix under Filter.
• If Tag is configured under And, there can be a maximum of 10 Tag nodes, and the tag keys must be different.
• If AbortIncompleteMultipartUpload exists as a child node of Rule, Tag cannot be configured to filter fragments.
• If the tags in multiple rules overlap and lifecycle actions conflict, the configuration is not allowed. For example, rule 1 uses one tag (key1, value1) and deletes objects 90 days after creation, while rule 2 uses two tags (key1, value1; key2, value2) and transitions objects to COLD 120 days after creation. In this case, the tags in two rules overlap and lifecycle actions conflict, so such configuration is not allowed.

Range:

For details, see Table 11.

Default value:

None

Tag

No

Container

Definition:

Tag element, which is used to identify the objects that can match the current rule.

Constraints:

• If Tag is configured as a child node of Filter, there can be only one Tag node. If Filter has a Prefix child node, there cannot be any Tag node at the same level with Prefix under Filter.
• If Tag is configured under And, there can be a maximum of 10 Tag nodes, and the tag keys must be different.
• If AbortIncompleteMultipartUpload exists as a child node of Rule, Tag cannot be configured to filter fragments.
• If the tags in multiple rules overlap and lifecycle actions conflict, the configuration is not allowed. For example, rule 1 uses one tag (key1, value1) and deletes objects 90 days after creation, while rule 2 uses two tags (key1, value1; key2, value2) and transitions objects to COLD 120 days after creation. In this case, the tags in two rules overlap and lifecycle actions conflict, so such configuration is not allowed.

Range:

For details, see Table 11.

Default value:

None

Key

Yes if Tag is present.

String

Definition:

The key of the tag.

Constraints:

None

Range:

The key name is case-sensitive and must be unique. It consists of 0 to 128 characters and cannot be blank. The following characters are not allowed: =*<>\,|/?!;

Default value:

None

Value

Yes if Tag is present.

String

Definition:

The value of the tag.

Constraints:

None

Range:

The key value is case-sensitive and consists of 0 to 255 characters. It can be blank and cannot contain the following characters: =*<>\,|?!;

Default value:

None