Object Storage Service:Query information about a bucket using OSS SDK for Go 2.0

Prerequisites

Before you begin, ensure that you have:

• An OSS bucket

• The oss:GetBucketInfo permission on the target bucket. For setup instructions, see Attach a custom policy to a RAM user

• Access credentials configured as environment variables. See Configure access credentials

Usage notes

• The sample code uses region ID cn-hangzhou (China (Hangzhou)). For other regions, replace it with the appropriate region ID. See Regions and endpoints.

• To access a bucket from an Elastic Compute Service (ECS) instance in the same region, use the internal endpoint instead of the public endpoint.

Method

func (c *Client) GetBucketInfo(ctx context.Context, request *GetBucketInfoRequest, optFns ...func(*Options)) (*GetBucketInfoResult, error)

Examples

The following example retrieves information about a bucket and logs the result:

package main

import (
	"context"
	"flag"
	"log"

	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss"
	"github.com/aliyun/alibabacloud-oss-go-sdk-v2/oss/credentials"
)

var (
	region     string
	bucketName string
)

func init() {
	flag.StringVar(&region, "region", "", "The region where the bucket is located.")
	flag.StringVar(&bucketName, "bucket", "", "The name of the bucket.")
}

func main() {
	flag.Parse()

	if len(bucketName) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, bucket name required")
	}

	if len(region) == 0 {
		flag.PrintDefaults()
		log.Fatalf("invalid parameters, region required")
	}

	// Load the default configuration with credentials from environment variables.
	cfg := oss.LoadDefaultConfig().
		WithCredentialsProvider(credentials.NewEnvironmentVariableCredentialsProvider()).
		WithRegion(region)

	client := oss.NewClient(cfg)

	request := &oss.GetBucketInfoRequest{
		Bucket: oss.Ptr(bucketName),
	}

	result, err := client.GetBucketInfo(context.TODO(), request)
	if err != nil {
		log.Fatalf("failed to get bucket info: %v", err)
	}

	log.Printf("bucket info: %v\n", result.BucketInfo)
}

For the complete runnable sample, see get_bucket_info.go on GitHub.

BucketInfo fields

The result.BucketInfo struct exposes the following fields:

What's next

• For an overview of OSS buckets, see Buckets.

• For the full API reference, see GetBucketInfo.