Overview

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

SDK API Reference

For the parameters and method descriptions of all the APIs in the SDK, see Api Documentation.

Querying a Bucket List

API description

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

Sample code

try
{
  GetServiceRequest request = new GetServiceRequest();
  // Execute the request
  GetServiceResult result = cosXml.GetService(request);
  // Get the list of all buckets
  List<ListAllMyBuckets.Bucket> allBuckets = result.listAllMyBuckets.buckets;
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more sample, please visit GitHub.

Creating a Bucket

API description

This API is used to create a bucket.

Sample code

try
{
  String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
  PutBucketRequest request = new PutBucketRequest(bucket);
  // Execute the request
  PutBucketResult result = cosXml.PutBucket(request);
  // Request successful
  Console.WriteLine(result.GetResultInfo());
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more samples, please visit GitHub.

Checking a Bucket and Its Permissions

API description

This API is used to check whether a bucket exists and whether you have the permission to access it. Possible scenarios are outlined below:

• 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.

Sample code

try
{
  String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
  HeadBucketRequest request = new HeadBucketRequest(bucket);
  // Execute the request
  HeadBucketResult result = cosXml.HeadBucket(request);
  // Request successful
  Console.WriteLine(result.GetResultInfo());
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more samples, please visit GitHub.

Deleting a Bucket

API description

This API is used to delete a specified bucket.

Note：

Before deleting a bucket, please make sure that all the data and incomplete multipart uploads in the bucket have been deleted; otherwise, the bucket cannot be deleted.

Sample code

try
{
  String bucket = "examplebucket-1250000000"; // Format: BucketName-APPID
  DeleteBucketRequest request = new DeleteBucketRequest(bucket);
  // Execute the request
  DeleteBucketResult result = cosXml.DeleteBucket(request);
  // Request successful
  Console.WriteLine(result.GetResultInfo());
}
catch (COSXML.CosException.CosClientException clientEx)
{
  // Request failed
  Console.WriteLine("CosClientException: " + clientEx);
}
catch (COSXML.CosException.CosServerException serverEx)
{
  // Request failed
  Console.WriteLine("CosServerException: " + serverEx.GetInfo());
}

Note：

For more samples, please visit GitHub.