Actions on Buckets

Note

This document provides an overview of APIs and SDK sample codes related to the basic operations and the access control list (ACL) for a bucket.

Basic Operations

Access control list

Basic Operations

Query Bucket list

Function description

Query all Bucket lists under the specified account.

Method prototype

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

Request Sample

s, resp, err := c.Service.Get(context.Background()) 

Return result description

Request result is returned through GetServiceResult.

type ServiceGetResult struct {
    Owner   *Owner  
    Buckets []Bucket 
}
type Owner struct {
    ID          string 
    DisplayName string                                              
}
type Bucket struct {
    Name       string
    Region     string
    CreationDate string                                               
} 

Create Bucket

Function description

Create a Bucket under the specified account.

Method prototype

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

Request Sample

opt := &cos.BucketPutOptions{
    XCosACL: "public-read",
}
resp, err := client.Bucket.Put(context.Background(), opt)

Parameter description

type BucketPutOptions struct {
    XCosACL              string 
    XCosGrantRead        string  
    XCosGrantWrite       string  
    XCosGrantFullControl string 
}

Retrieval of Bucket and its Permission

Function description

Retrieves whether Bucket exists and has Permission Access.

Method prototype

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

Request Sample

resp, err := client.Bucket.Head(context.Background())

Deleting Buckets

Function description

Deletes the empty Bucket under the specified account.

Method prototype

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

Request Sample

resp, err := client.Bucket.Delete(context.Background())

Access control list

Setting Bucket ACL

Function description

Sets the specified Bucket Access Permission control list (PUT Bucket acl).

Method prototype

func (s *BucketService) PutACL(ctx context.Context, opt *BucketPutACLOptions) (*Response, error)

Request Sample

// 1. Set Bucket ACL by header.
opt := &cos.BucketPutACLOptions{
    Header: &cos.ACLHeaderOptions{
        //private，public-read，public-read-write
        XCosACL: "private",
    },
}
resp, err := client.Bucket.PutACL(context.Background(), opt)

// 2. Set Bucket ACL by body.
opt := &cos.BucketPutACLOptions{
    Body: &cos.ACLXml{
        Owner: &cos.Owner{
            ID: "qcs::cam::uin/100000760461:uin/100000760461",
        },
        AccessControlList: []cos.ACLGrant{
            {
                Grantee: &cos.ACLGrantee{
            // Type can also chose the "Group", "CanonicalUser"
                    Type: "RootAccount",
                    ID:"qcs::cam::uin/100000760461:uin/100000760461",
                },
        // Permission can also chose the "WRITE"，"FULL_CONTROL" 
                Permission: "FULL_CONTROL",
            },
        },
    },
}
resp, err := client.Bucket.PutACL(context.Background(), opt)

Parameter description

type ACLHeaderOptions struct {
    XCosACL              string 
    XCosGrantRead        string 
    XCosGrantWrite       string 
    XCosGrantFullControl string 
}

Query Bucket ACL

Function description

Query the Access Permission control list (GET Bucket acl) for the specified Bucket.

Method prototype

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

Request Sample

v, resp, err := client.Bucket.GetACL(context.Background())

Return result description

Request result is returned through GetBucketACLResult.

type ACLXml struct {
    Owner             *Owner
    AccessControlList []ACLGrant 
}
type Owner struct { 
    ID          string 
    DisplayName string
}
type ACLGrant struct {
    Grantee    *ACLGrantee
    Permission string
}
type ACLGrantee struct {
    Type        string 
    ID          string 
    DisplayName string
    UIN         string 
}