tencent cloud


Checking Whether Buckets Exist

Last updated: 2022-05-26 14:50:34


    This document provides sample code for quickly checking whether a bucket exists.

    The sample code actually calls the HEAD Bucket COS API and is a simplified version of the API.

    In addition to checking whether a bucket exists, HEAD Bucket also checks whether you have permission to access the bucket. Possible scenarios are as follows:

    • If the bucket exists and you have permission to read it, HTTP status code 200 will be returned.
    • If you do not have permission to read the bucket, HTTP status code 403 will be returned.
    • If the bucket does not exist, HTTP status code 404 will be returned.

    Checking Whether a Bucket Exists


    You can check whether a bucket exists by using the shortcut API provided by the SDK.


    The COS Go SDK version should not be earlier than v0.7.33.

    Method prototype

    func (s *BucketService) IsExist(ctx context.Context) (isExist bool, err error)

    Sample code

    package main
    import (
    func main() {
          // Bucket name in the format of BucketName-APPID (APPID is required), which can be viewed in the COS console at https://console.tencentcloud.com/cos5/bucket
          // Replace it with your region, which can be viewed in the COS console at https://console.tencentcloud.com/. For more information about regions, see https://www.tencentcloud.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.tencentcloud.com/cam/capi
                          SecretID: os.Getenv("SECRETID"),
                          // Environment variable `SECRETKEY` refers to the user's SecretKey, which can be viewed at https://console.tencentcloud.com/cam/capi
                          SecretKey: os.Getenv("SECRETKEY"),
           ok, err := client.Bucket.IsExist(context.Background())
          if err == nil && ok {
                  fmt.Printf("bucket exists\n")
          } else if err != nil {
                  fmt.Printf("head bucket failed: %v\n", err)
          } else {
                  fmt.Printf("bucket does not exist\n")

    Response description

    Parameter Description Type
    isExist Whether the bucket exists bool
    err Whether the request is successful struct
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support