Obtaining an Online Decompression Policy

Function

This API is used by the bucket owner or users who have the required permission to obtain the online decompression policy of a bucket. If the policy exists, a success message is returned with status code 200.

Restrictions

To call this API, you must be the bucket owner or have the permission to obtain 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.

Method

func (obsClient ObsClient) GetBucketDecompression(input *GetBucketDecompressionInput) (output *GetBucketDecompressionOutput, err error)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
input	*GetBucketDecompressionInput	Yes	Explanation: Request parameters for obtaining the online decompression policy. For details, see Table 2.

**Table 2** GetBucketDecompressionInput
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

Responses

**Table 3** List of returned results
Parameter	Type	Description
output	*GetBucketDecompressionOutput	Explanation: Returned results. For details, see Table 4.
err	error	Explanation: The error message returned by the server.

**Table 4** GetBucketDecompressionOutput
Parameter	Type	Description
StatusCode	int	Explanation: HTTP status code. 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. Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers. Default value: None
Rules	[]DecompressionRule	Explanation: Online decompression policy. Value range: See Table 5. Default value: None

**Table 5** 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

Sample Code

This example obtains the online decompression policy of 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.GetBucketDecompressionInput{}
    // Specify a bucket name.
    input.Bucket = "examplebucket
    // Obtain the online decompression policy of the bucket.
    output, err := obsClient.GetBucketDecompression(bucketName)
    if err == nil {
	fmt.Printf("Get bucket(%s)'s decompression policy successful!\n", bucketName)
        fmt.Printf("Decompression rules count: %d\n", len(output.Rules))
        for index, rule := range output.Rules {
            fmt.Printf("Rule[%d] - ID: %s, Prefix: %s, Suffix: %s, PolicyType: %s\n",
            index, rule.ID, rule.Prefix, rule.Suffix, rule.PolicyType)
        }
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Get 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)
    }
}

Helpful Links

Parent topic: Online Decompression

Previous topic: Configuring an Online Decompression Policy

Next topic: Deleting an Online Decompression Policy