Updated on 2026-08-14 GMT+08:00

Configuring an Online Decompression Policy

You can call this API to configure a ZIP file decompression policy for a bucket. The API is idempotent. If there is already an identical policy for the bucket, a success message is returned with status code 200. Otherwise, status code 201 is returned.

Restrictions

  • To call this API, you must be the bucket owner or have the permission to configure the online decompression policy. You are advised to use IAM or bucket policies for authorization. For more information about OBS authorization methods, see Differences Between OBS Permissions Control Methods.
  • The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
  • Permissions
    • To configure, obtain, or delete online decompression policies, you must have the Tenant Administrator permission assigned by using role/policy-based authorization of IAM.
    • Online decompression requires that you create an IAM agency to delegate OBS to access data in the bucket. The permissions the agency should assign to OBS include obs:object:PutObject, obs:object:GetObject, and obs:object:AbortMultipartUpload.
  • Package and file size
    • A single ZIP package cannot exceed 1 GB in size.
    • A single ZIP package can contain a maximum of 65,536 files.
    • A single decompressed file cannot exceed 40 GB in size.
  • Time
    • Decompressing a ZIP package takes 10 minutes at most.
  • Functions
    • Currently, only ZIP packages are supported.
    • ZIP package names cannot contain Chinese punctuation marks, special characters, or special codes.
    • To decompress the ZIP package that contains other ZIP packages, the event type of the online decompression policy must be set to ObjectCreated:* or ObjectCreated:CompleteMultipartUpload.
    • Currently, no notification will be sent to users after decompression tasks are complete.
    • Currently, only deflate-compressed ZIP packages can be decompressed. Deflate is different from the compression algorithms (such as Store and Normal) provided by WinRAR.
    • The total length of the decompression path plus the name of any decompressed file cannot exceed 512 characters.
    • Currently, encrypted ZIP packages cannot be decompressed.
    • Federated users cannot use the online decompression function. For more information about federated users, see What Are the Relationships Between a Huawei Cloud Account, HUAWEI ID, IAM User, and Federated User? and Introduction to Identity Providers.

Method

func (obsClient ObsClient) SetBucketDirectColdAccess(input *SetBucketDecompressionInput) (output *BaseModel, err error)

Request Parameters

Table 1 List of request parameters

Parameter

Type

Mandatory (Yes/No)

Description

input

*SetBucketDecompressionInput

Yes

Explanation:

Request parameters for configuring the online decompression policy. For details, see Table 2.

Table 2 SetBucketDecompressionInput

Parameter

Type

Mandatory (Yes/No)

Description

Bucket

string

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

[]DecompressionRule

Yes

Explanation:

Online decompression policy.

Value range:

See Table 3.

Default value:

None

Table 3 DecompressionRule

Parameter

Type

Mandatory (Yes/No)

Description

ID

string

Yes

Explanation:

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

Value range:

[1, 256]. The value can contain 1 to 256 characters, matching the regular expression of ^[a-zA-Z0-9_-]{1, 256}$. It consists of only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-), for example, event_0001.

Default value:

None

Project

string

Yes

Explanation:

Project ID.

Default value:

None

Agency

string

Yes

Explanation:

Agency name. With an agency, you can grant OBS the permissions to query whether a specified object exists in the bucket and to upload objects to the bucket.

Default value:

None

Events

[]string

Yes

Explanation:

Trigger event type.

Value range:

["ObjectCreated:*"]
["ObjectCreated:Put"]
["ObjectCreated:Post"]
["ObjectCreated:Copy"]
["ObjectCreated:CompleteMultipartUpload"]

Prefix

string

No

Explanation:

Prefix defined in the rule.

Value range:

[0, 1023]

Suffix

string

Yes

Explanation:

Suffix defined in the rule.

Value range:

Fixed value: .zip

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.

DecompressPath

string

No

Explanation:

Path for storing decompressed files. If the value is not empty, it must end with a slash (/) but cannot start with a slash (/).

Value range:

[0, 800]

PolicyType

string

Yes

Explanation:

Type of the decompression policy.

Value range:

Fixed value: decompress

Responses

Table 4 List of returned results

Parameter

Type

Description

output

*BaseModel

Explanation:

Returned results. For details, see Table 5.

err

error

Explanation:

The error message returned by the server.

Table 5 BaseModel

Parameter

Type

Description

StatusCode

int

Explanation:

HTTP status code

Restrictions:

None

Value range:

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

Default value:

None

RequestId

string

Explanation:

Request ID returned by the OBS server

Restrictions:

None

Value range:

None

Default value:

None

ResponseHeaders

map[string][]string

Explanation:

HTTP response headers

Restrictions:

None

Value range:

None

Default value:

None

Sample Code

This example configures an online decompression policy for bucket examplebucket.
package main
import (
    "fmt"
    "os"

    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    // Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    // Obtain an AK/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")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    securityToken := os.Getenv("SecurityToken")


    // Enter the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "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, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.SetBucketDecompressionInput{}
    // Specify a bucket name.
    input.Bucket = "examplebucket"
    // Specify an online decompression policy.
    var rules []obs.DecompressionRule
    rule := obs.DecompressionRule{}
    rule.ID = fmt.Sprintf("rule-%d", time.Now().Unix())
    rule.Project = "your-project-id"
    rule.Agency = "your-agency-name"
    rule.Events = []string{"ObjectCreated:Post"}
    rule.Prefix = "compressed/"
    rule.Suffix = ".zip"
    rule.Overwrite = 1
    rule.DecompressPath = "extracted/"
    rule.PolicyType = "decompress"
    rules = append(rules, rule)
    setInput.Rules = rules
    // Configure the online decompression policy.
    output, err := obsClient.SetBucketDecompression(bucketName)
    if err == nil {
	fmt.Printf("Set bucket(%s)'s decompression policy successful!\n", bucketName)
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Set bucket(%s)'s decompression policy fail!\n", bucketName)
    if obsError, ok := err.(obs.ObsError); ok {
	fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
	fmt.Println(obsError.Error())
    } else {
	fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
	fmt.Println(err)
    }
}