Overview

This document provides an overview of APIs and SDK code samples related to basic bucket operations.

Querying a Bucket List

Feature description

This API is used to query the list of all buckets under a specified account.

Method prototype

func (s *ServiceService) Get(ctx context.Context) (*ServiceGetResult, *Response, error)

Sample request

s, _, err := c.Service.Get(context.Background())
if err != nil {
   panic(err)
}

Response description

The result of the request is returned through GetServiceResult.

type ServiceGetResult struct {
  Owner   *Owner  
  'Bucket' => $bucket 
}
type Owner struct {
  ID          string 
  DisplayName string                                              
}
type Bucket struct {
Name       string
  Region     string
  CreationDate string                                               
} 

Creating a Bucket

Feature description

This API is used to create a bucket under a specified account.

Method prototype

func (s *BucketService) Put(ctx context.Context, opt *BucketPutOptions) (*Response, error)

Sample request

opt := &cos.BucketGetOptions{
   XCosACL: "private",
}
_, err := client.Bucket.Put(context.Background(), opt)
if err != nil {
   panic(err)
}

// Create a multi-AZ bucket
opt.CreateBucketConfiguration = &cos.CreateBucketConfiguration{
   BucketAZConfig: "MAZ",
}
_, err := client.Bucket.Put(context.Background(), opt)
if err != nil {
   panic(err)
}

Parameter description

type BucketPutOptions struct {
XCosACL              string 
XCosGrantRead        string  
XCosGrantWrite       string  
XCosGrantFullControl string 
   CreateBucketConfiguration *CreateBucketConfiguration
}
type CreateBucketConfiguration struct {
   BucketAZConfig string
}

Checking a Bucket and Its Permissions

Feature description

This API is used to verify whether a bucket exists and you have the permission to access it.

Method prototype

func (s *BucketService) Head(ctx context.Context) (*Response, error)

Sample request

_, err := client.Bucket.Head(context.Background())
if err != nil {
   panic(err)
}

Deleting a Bucket

Feature description

This API (DELETE Bucket) is used to delete an empty bucket under a specified account.

Method prototype

func (s *BucketService) Delete(ctx context.Context) (*Response, error)

Sample request

_, err := client.Bucket.Delete(context.Background())
if err != nil {
   panic(err)
}