tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to the access control lists (ACLs) for buckets and objects.

Bucket ACL

Object ACL

Bucket ACL

Setting a bucket ACL

Description

This API is used to set the access control list (ACL) of a specified bucket.

Method prototype

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

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main() {
   // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   // 1. Configure the bucket ACL through the request header
   opt := &cos.BucketPutACLOptions{
       Header: &cos.ACLHeaderOptions{
           // private, public-read, public-read-write
           XCosACL: "private",
       },
   }
   _, err := client.Bucket.PutACL(context.Background(), opt)
   if err != nil {
       panic(err)
   }
     // 2. Configure the bucket ACL through the request body
   opt = &cos.BucketPutACLOptions{
       Body: &cos.ACLXml{
           Owner: &cos.Owner{
               ID: "qcs::cam::uin/100000000001:uin/100000000001",
           },
           AccessControlList: []cos.ACLGrant{
               {
                   Grantee: &cos.ACLGrantee{
                       'Type': 'CanonicalUser'|'Group',
                       Type: "RootAccount",
                       ID:   "qcs::cam::uin/100000760461:uin/100000760461",
                   },
                   'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
                   Permission: "FULL_CONTROL",
               },
           },
       },
   }
   _, err = client.Bucket.PutACL(context.Background(), opt)
   if err != nil {
       panic(err)
   }
}

Parameter description

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

Querying a bucket ACL

Description

This API is used to query the ACL of a specified bucket.

Method prototype

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

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main() {
   // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   _, _, err := client.Bucket.GetACL(context.Background())
   if err != nil {
       panic(err)
   }
}

Response description

The result of the request 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
  URI         string 
}

Object ACL

Setting an object ACL

Description

This API is used to set an ACL for an object.

Method prototype

func (s *ObjectService) PutACL(ctx context.Context, key string, opt *ObjectPutACLOptions) (*Response, error)

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main() {
   // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   // 1. Configure through the request header
   opt := &cos.ObjectPutACLOptions{
       Header: &cos.ACLHeaderOptions{
           XCosACL: "private",
       },
   }
   key := "exampleobject"
   _, err := client.Object.PutACL(context.Background(), key, opt)
   if err != nil {
       panic(err)
   }
   // 2. Configure through the request body
   opt = &cos.ObjectPutACLOptions{
       Body: &cos.ACLXml{
           Owner: &cos.Owner{
               ID: "qcs::cam::uin/100000000001:uin/100000000001",
           },
           AccessControlList: []cos.ACLGrant{
               {
                   Grantee: &cos.ACLGrantee{
                       Type: "RootAccount",
                       ID:   "qcs::cam::uin/100000760461:uin/100000760461",
                   },
                    Permission: "FULL_CONTROL",
               },
           },
       },
   }
   _, err = client.Object.PutACL(context.Background(), key, opt)
   if err != nil {
       panic(err)
   }
}

Parameter description

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

Querying an object ACL

Description

This API is used to query the ACL of an object.

Method prototype

func (s *ObjectService) GetACL(ctx context.Context, key string) (*ObjectGetACLResult, *Response, error)

Sample request

package main
import (
   "context"
   "github.com/tencentyun/cos-go-sdk-v5"
   "net/http"
   "net/url"
   "os"
)
func main() {
   // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
   // Replace it with your region, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/. For more information about regions, see https://intl.cloud.tencent.com/document/product/436/6224.
   u, _ := url.Parse("https://examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com")
   b := &cos.BaseURL{BucketURL: u}
   client := cos.NewClient(b, &http.Client{
       Transport: &cos.AuthorizationTransport{
           // Get the key from environment variables
           // Environment variable `SECRETID` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretID: os.Getenv("SECRETID"),
           // Environment variable `SECRETKEY` refers to the user's SecretId, which can be viewed at https://console.intl.cloud.tencent.com/cam/capi
           SecretKey: os.Getenv("SECRETKEY"),
       },
   })
   key := "exampleobject"
   _, _, err := client.Object.GetACL(context.Background(), key)
   if err != nil {
       panic(err)
   }
}

Parameter description

Response description

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
  URI         string 
}