Help Center/ Object Storage Service/ SDK Reference/ Go/ Buckets (SDK for Go)/ Obtaining the Bucket Encryption Configuration (SDK for Go)

Updated on 2024-09-05 GMT+08:00

View PDF

Obtaining the Bucket Encryption Configuration (SDK for Go)

Function

After you enable encryption for a bucket, the objects you upload to this bucket will be encrypted with the specified encryption method before they are stored in OBS. When you later download these encrypted objects, OBS decrypts them first and then returns them to you.

This API returns the encryption configuration of a bucket.

Restrictions

To obtain the encryption configuration of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetEncryptionConfiguration in IAM or GetEncryptionConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

func (obsClient ObsClient) GetBucketEncryption(bucketName string) (output *GetBucketEncryptionOutput, err error)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
bucketName	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 of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Value range: The value must contain 3 to 63 characters.

Responses

**Table 2** List of returned results
Parameter	Type	Description
output	*GetBucketEncryptionOutput	Explanation: Returned results. For details, see Table 3.
err	error	Explanation: Error messages returned by the API

**Table 3** GetBucketEncryptionOutput
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
SSEAlgorithm	string	Explanation: Objects are encrypted using SSE-KMS on the server side. Value range: kms Default value: None
KMSMasterKeyID	string	Explanation: ID of the KMS master key used for SSE-KMS Value range: Valid value formats are as follows: regionID:domainID:key/key_id key_id In the preceding formats: regionID indicates the ID of the region where the key is used. You can obtain it from Regions and Endpoints. domainID indicates the ID of the account where the key is used. To obtain it, see How Do I Get My Account ID and User ID? key_id indicates the ID of the key created on Data Encryption Workshop (DEW). To obtain it, see Viewing a CMK. Default value: If this parameter is not specified, the default master key will be used.
ProjectID	string	Explanation: ID of the project where the KMS master key belongs in SSE-KMS Restrictions: The project ID must match KMSMasterKeyID. Leave the project ID blank if KMSMasterKeyID is not specified. Value range: To obtain the enterprise project ID, see How Do I Obtain a Project ID?. Default value: None

Code Examples

This example returns the encryption configuration 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 advised not to use hard coding to reduce leakage risks. 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())
    }
    // Specify a bucket name.
    bucketname := "examplebucket"
    // Obtain the encryption configuration of the bucket.
    output, err := obsClient.GetBucketEncryption(bucketname)
    if err == nil {
        fmt.Printf("Get bucket(%s)'s encryption configuration successful!\n", bucketname)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        fmt.Printf("Encryption:%s\n", output.SSEAlgorithm)
        fmt.Printf("KeyID:%s\n", output.KMSMasterKeyID)
        return
    }
    fmt.Printf("Get bucket(%s)'s encryption configuration 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)
    }
}

        

      

    
   