Obtaining the Direct Reading Configuration of Archive Storage Objects in a Bucket

Function

A bucket owner can call this API to obtain the direct reading status of Archive Storage objects in the bucket.

If direct reading has never been configured for Archive Storage objects in the bucket or the direct reading configuration has been deleted, no direct reading status will be returned after this API call.

If direct reading of Archive Storage objects is configured for a bucket, you can call this API to obtain the direct reading status of Archive Storage objects in the bucket. For more information about direct reading of Archive Storage data, see Direct Reading.

Restrictions

• To obtain the direct reading configuration of Archive Storage objects in a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetDirectColdAccessConfiguration granted using IAM or GetDirectColdAccessConfiguration granted using 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) GetBucketDirectColdAccess(BucketName *string) (output *GetBucketDirectColdAccessOutput, err error)

Request Parameters

Responses

Sample Code

This example obtains the direct reading status of Archive Storage objects in bucket examplebucket.

package main
import (
    "fmt"


    "os"
)
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.
    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())
    }
    // Specify a bucket name.
    bucketName := "examplebucket"
    // Obtain the direct reading status of Archive Storage objects in the bucket.
    output, err := obsClient.GetBucketDirectColdAccess(bucketName)
    if err == nil {
        fmt.Printf("Get bucket(%s)'s direct cold successful!\n", bucketName)
        fmt.Printf("Direct cold access status: %s\n", output.Status)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        return
    }
    fmt.Printf("Get bucket(%s)'s direct cold 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

• The API for obtaining the direct reading configuration of Archive objects in a bucket
• OBS Error Codes
• Direct Reading