All Products
Document Center

Object Storage Service:Determine whether a bucket exists

Last Updated:Sep 06, 2023

A bucket is a container used to store objects in Object Storage Service (OSS). Every object is contained in a bucket. This topic describes how to determine whether a bucket exists.

Usage notes

  • In this topic, the public endpoint of the China (Hangzhou) region is used. If you want to access OSS by using other Alibaba Cloud services in the same region as OSS, use an internal endpoint. For more information about the regions and endpoints supported by OSS, see Regions and endpoints.

  • In this topic, access credentials are obtained from environment variables. For more information about how to configure access credentials, see Configure access credentials.

  • In this topic, an OSSClient instance is created by using an OSS endpoint. If you want to create an OSSClient instance by using custom domain names or Security Token Service (STS), see Initialization.

  • To determine whether a bucket exists, you must have the oss:GetBucketAcl permission. For more information, see Common examples of RAM policies.


The following code provides an example on how to determine whether a specified bucket exists:

# -*- coding: utf-8 -*-
import oss2
from oss2.credentials import EnvironmentVariableCredentialsProvider
# Obtain access credentials from environment variables. Before you run the sample code, make sure that the OSS_ACCESS_KEY_ID and OSS_ACCESS_KEY_SECRET environment variables are configured. 
auth = oss2.ProviderAuth(EnvironmentVariableCredentialsProvider())
# Specify the endpoint of the region in which the bucket is located. For example, if the bucket is located in the China (Hangzhou) region, set the endpoint to 
# Specify the name of the bucket. 
bucket = oss2.Bucket(auth, '', 'yourBucketName')

def does_bucket_exist(bucket):
    except oss2.exceptions.NoSuchBucket:
        return False
    return True

# Determine whether the specified bucket exists. If the bucket exists, true is returned. Otherwise, false is returned. 
exist = does_bucket_exist(bucket)
if exist:
    print('bucket exist')
    print('bucket not exist')


For the complete sample code that is used to determine whether a bucket exists, visit GitHub.