tencent cloud

All product documents
Cloud Object Storage
DocumentationCloud Object StorageSDK Documentation.NET(C#) SDKBucket OperationsChecking Whether Buckets Exist
Checking Whether Buckets Exist
Download PDF
Last updated: 2024-02-02 14:36:36
Checking Whether Buckets Exist
Last updated: 2024-02-02 14:36:36
Download PDF

Overview

This document provides an overview of APIs and SDK code samples related to checking whether a bucket exists.
API
Operation
Description
Checking a bucket and its permissions
Checks whether a bucket exists and whether you have permission to access it

Checking Whether a Bucket Exists

Description

This API (DoesBucketExist) is used to check whether a bucket exists.
Note:
The DoesBucketExist API is a simple version of the HEAD Bucket API provided by the .NET SDK. It can only be used to check whether a bucket exists and return a Boolean value.
To get the details of a bucket, use the bucket extraction API.

Sample code

using COSXML.Model.Bucket;
using COSXML.Auth;
using System;
using COSXML;

namespace COSSnippet
{
    public class DoesBucketExistModel {

      private CosXml cosXml;

      DoesBucketExistModel() {
        CosXmlConfig config = new CosXmlConfig.Builder()
          .SetRegion("COS_REGION") // Set the default region. For abbreviations of COS regions, visit https://www.tencentcloud.com/document/product/436/6224?from_cn_redirect=1. 
          .Build();

        string secretId = "SECRET_ID";   // SecretId of the TencentCloud API. For more information about how to obtain the API key, see https://console.tencentcloud.com/cam/capi.
        string secretKey = "SECRET_KEY"; // SecretKey of the TencentCloud API. For more information about how to obtain the API key, see https://console.tencentcloud.com/cam/capi.
        long durationSecond = 600;          // Validity period of the request signature in seconds
        QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId, 
          secretKey, durationSecond);

        this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
      }

      /// Check whether a bucket exists
      public void DoesBucketExist()
      {
        try
        {
          // Bucket name in the format of `BucketName-APPID`. You can get APPID by referring to https://console.tencentcloud.com/developer.
          string bucket = "examplebucket-1250000000";
          DoesBucketExistRequest request = new DoesBucketExistRequest(bucket);
          // Execute the request
          bool existState = cosXml.DoesBucketExist(request);
          // Request succeeded
          Console.WriteLine("bucket exist state is: " + existState);
        }
        catch (COSXML.CosException.CosClientException clientEx)
        {
          // Request failed
          Console.WriteLine("CosClientException: " + clientEx);
        }
        catch (COSXML.CosException.CosServerException serverEx)
        {
          // Request failed
          Console.WriteLine("CosServerException: " + serverEx.GetInfo());
        }

      }

      static void Main(string[] args)
      {
        DoesBucketExistModel m = new DoesBucketExistModel();

        /// Check whether a bucket exists
        m.DoesBucketExist();
      }
    }
}
Note:
For the complete sample, go to GitHub.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon