Help Center/ Object Storage Service/ SDK Reference/ Python/ Object-Related APIs (SDK for Python)/ Basic Operations (SDK for Python)/ Configuring WORM Retention for an Object (SDK for Python)
Updated on 2026-07-31 GMT+08:00
View PDF
Share

Configuring WORM Retention for an Object (SDK for Python)

Function

This API is used to configure or update the retention period for objects uploaded to a bucket with WORM enabled.

  • If you did not configure a retention period or apply the default bucket-level protection rule when uploading an object, you can perform this operation to configure a retention period for the object.
  • If you already configured a retention period or applied the default bucket-level protection rule when uploading an object, you can perform this operation to prolong the retention period for the object.
  • The retention period of an object can only be modified, but not deleted.

Restrictions

Method

ObsClient.putObjectRetention(bucketName, objectKey, mode, retainUntilDate, versionId, extensionHeaders)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

bucketName

str

Yes

Explanation:

Bucket name

Restrictions:

  • A bucket name must be unique across all accounts and regions.
  • A bucket name:
    • Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed.
    • Cannot be formatted as an IP address.
    • Cannot start or end with a hyphen (-) or period (.).
    • Cannot contain two consecutive periods (..), for example, my..bucket.
    • Cannot contain a period (.) and a hyphen (-) adjacent to each other, for example, my-.bucket or my.-bucket.
  • If you repeatedly create buckets with the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request.

Default value:

None

objectKey

str

Yes

Explanation:

Object name. An object is uniquely identified by an object name in a bucket. An object name is a complete path of the object that does not contain the bucket name.

For example, if the address for accessing the object is examplebucket.obs.ap-southeast-1.myhuaweicloud.com/folder/test.txt, the object name is folder/test.txt.

Value range:

The value must contain 1 to 1,024 characters.

Default value:

None

mode

str

Yes

Explanation:

WORM retention policy of an object

Restrictions:

N/A

Value range:

COMPLIANCE: compliance mode

Default value:

None

retainUntilDate

int

Yes

Explanation:

Retention period of an object, for example, 1435728035000

Restrictions:

  • Its value is a timestamp accurate to milliseconds, for example, 1435728035000 (corresponding to 13:20:35 on July 1, 2015).
  • The retention period can only be prolonged but cannot be shortened.

Value range:

The value must be later than the current time.

Default value:

None

versionId

str

No

Explanation:

Object version ID, for example, G001117FCE89978B0000401205D5DC9

Value range:

The value must contain 32 characters.

Default value:

None. If this parameter is not specified, the latest version of the object is specified by default.

extensionHeaders

dict

No

Explanation:

Extension headers

Value range:

See User-defined Headers (SDK for Python).

Default value:

None

Responses

Table 2 Responses

Type

Description

GetResult

Explanation:

SDK common results
Table 3 GetResult

Parameter

Type

Description

status

int

Explanation:

HTTP status code

Value range:

A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code.

Default value:

None

reason

str

Explanation:

Reason description

Default value:

None

errorCode

str

Explanation:

Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

errorMessage

str

Explanation:

Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank.

Default value:

None

requestId

str

Explanation:

Request ID returned by the OBS server

Default value:

None

indicator

str

Explanation:

Error indicator returned by the OBS server

Default value:

None

hostId

str

Explanation:

Requested server ID. If the value of status is less than 300, this parameter is left blank.

Default value:

None

resource

str

Explanation:

Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank.

Default value:

None

header

list

Explanation:

Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header.

Default value:

None

body

object

Explanation:

Result content returned after the operation is successful. If the value of status is larger than 300, this parameter is left blank. The value varies with the API being called. For details, see the sections "Bucket-Related APIs" and "Object-Related APIs".

Default value:

None

Sample Code

This example sets the WORM retention period for object exampleobject in bucket examplebucket.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
import os
import time
import traceback

from obs import ObsClient

# Obtain an AK/SK pair using environment variables (recommended) or import it in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
# Before running the sample code, ensure that the environment variables AccessKeyID and SecretAccessKey have been configured.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# If you use a temporary AK/SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com"

# Create an obsClient instance.
# If you use a temporary AK/SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obs_client = ObsClient(access_key_id=ak, secret_access_key=sk, server=server) 
try: 
    bucket_name = 'examplebucket' 
    object_name = 'exampleobject' 
    # Retention policy of the object
    mode = 'COMPLIANCE' 
    # Retention period for the object. Its value is a timestamp accurate to milliseconds, for example, 1435728035000 (corresponding to 13:20:35 on July 1, 2015). The value of this field must be later than the current time. The retention period can be extended but cannot be shortened.
    retain_until_date = (int(time.time()) + 60*60*24)*1000 
    # Version ID of the object . If versionId is specified, the WORM policy of the specified object version is modified. If versionId is not specified, the latest version of the object is used.
    version_id = 'versionid' 

    # Set the retention period for the object.
    resp = obs_client.putObjectRetention(bucket_name, object_name, mode, retain_until_date) 

    # If status code 2xx is returned, the API call succeeds. Otherwise, the API call fails.
    if resp.status < 300: 
        print('Put Object Retention Succeeded') 
        print('requestId:', resp.requestId) 
    else: 
        print('Put Object Retention Failed') 
        print('requestId:', resp.requestId) 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage) 
except Exception: 
    print('Put Object Retention Failed') 
    print(traceback.format_exc())