Help Center/ Object Storage Service/ SDK Reference/ Python/ Bucket-Related APIs (SDK for Python)/ Online Decompression Policies (SDK for Python)/ Configuring an Online Decompression Policy (SDK for Python)
Updated on 2026-07-31 GMT+08:00
View PDF
Share

Configuring an Online Decompression Policy (SDK for Python)

Function

OBS can automatically decompress uploaded ZIP packages and save them to a specified directory. If any ZIP package uploaded to a bucket matches the configured decompression policy, the package will be automatically decompressed to the specified directory. You can call this API to configure a ZIP file decompression policy for a bucket. For more information about online decompression, see Online Decompression.

Online decompression is not available for fusion buckets.

Method

ObsClient.setObsCompressPolicy(bucketName, rules, extensionHeaders)

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

rules

list of Table 1

Yes

Explanation:

Number of policy rules. For details, see Table 1.

Restrictions:

For the same bucket, prefixes of different rules cannot be the same or contain each other. The same agency is recommended.

Value range:

1 to 10

Default value:

None

extensionHeaders

dict

No

Explanation:

Extension headers

Value range:

See User-defined Headers (SDK for Python).

Default value:

None
Table 1 ObsCompressPolicyRule

Parameter

Type

Mandatory (Yes/No)

Description

id

str

Yes

Explanation:

Name of a decompression rule. It is the unique ID of the decompression rule configured for the current bucket, for example, event_0001.

Restrictions:

  • It consists of only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-).
  • The total length of the decompression rule name, decompression path, and IAM agency name cannot exceed 800 characters.

Value range:

The value can be up to 256 characters long.

Default value:

None

project

str

Yes

Explanation:

Project ID

Value range:

N/A

Default value:

None

agency

str

Yes

Explanation:

IAM agency name

Restrictions:

  • The permissions the agency should assign to OBS include obs:object: PutObject, obs: object:GetObject and obs: object:AbortMultipartUpload.
  • The total length of the decompression rule name, decompression path, and IAM agency name cannot exceed 800 characters.

Default value:

None

events

list

Yes

Explanation:

Trigger event type

Value range:

["ObjectCreated:*"]

["ObjectCreated:Put"]

["ObjectCreated:Post"]

["ObjectCreated:Copy"]

["ObjectCreated:CompleteMultipartUpload"]

Default value:

None

prefix

str

No

Explanation:

Prefix defined in the rule

Value range:

The value can be up to 1,023 characters long.

Default value:

None

suffix

str

Yes

Explanation:

Suffix defined in the rule

Restrictions:

Currently, only .zip is supported.

Value range:

.zip

Default value:

None

overwrite

int

Yes

Explanation:

Method of processing a decompressed file if it has the same name as an existing file

Value range:

  • 0: Skip without overwriting.
  • 1: Do not overwrite (rename the file with the CRC32 value).
  • 2: Overwrite the existing file.

Default value:

None

decompresspath

str

No

Explanation:

Path for storing decompressed files

Restrictions:

  • If the value is not empty, it must end with a slash (/) but cannot start with a slash (/).
  • The total length of the decompression rule name, decompression path, and IAM agency name cannot exceed 800 characters.

Value range:

The value can be up to 800 characters long.

Default value:

None

policytype

str

Yes

Explanation:

Type of the decompression policy

Restrictions:

Currently, only decompress is supported.

Value range:

decompress

Default value:

decompress

Responses

Type

Description

GetResult

Explanation:

SDK common results
Table 2 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 configures an online decompression policy for 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
45
46
47
48
49
50
51
52
 
from obs import ObsClient, ObsCompressPolicyRule
import os
import traceback

# 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.
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.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName = 'examplebucket'
    # Configure an online decompression policy.
    rule = ObsCompressPolicyRule(
        id='rule_id',
        project='your_project_id',
        # The permissions the agency should assign to OBS include obs:object: PutObject, obs: object:GetObject and obs: object:AbortMultipartUpload.
        agency='your_agency',
        # Trigger event type
        events=['ObjectCreated:*'],
        # Prefix defined in the rule
        prefix='zip/',
        # Suffix defined in the rule
        suffix='.zip',
        # Method of processing decompressed files with the same names as existing files
        overwrite=0,
        # Path for storing decompressed files
        decompresspath='decompressed/',
        # Type of the file decompression policy. Currently, only decompress is supported.
        policytype='decompress'
    )
    rules = [rule]
    resp = obsClient.setObsCompressPolicy(bucketName, rules)

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