Obtaining Storage Information of a Bucket (SDK for Python)

Function

This API returns the storage information of a bucket, including the number of objects and the space occupied by the objects in the bucket.

OBS measures bucket storage statistics in the background and does not update the storage information in real time. So, you are advised not to perform real-time verification on the storage information.

Restrictions

To obtain the storage information of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketStorage in IAM or GetBucketStorage in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

ObsClient.getBucketStorageInfo(bucketName, extensionHeaders)

Request Parameters

**Table 1** List of request parameters
Parameter	Type	Mandatory (Yes/No)	Description
bucketName	str	Yes	Explanation: Bucket name Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket properties comply with those set in the first creation request. Default value: None
extensionHeaders	dict	No	Explanation: Extension headers Value range: See User-defined Header (SDK for Python). Default value: None

Responses

**Table 2** List of returned results
Type	Description
GetResult	Explanation: SDK common results

**Table 3** GetResult
Parameter	Type	Description
status	int	Explanation: HTTP status code Value range: A status code is a group of digits ranging from 2xx (indicating successes) to 4xx or 5xx (indicating errors). It indicates the status of a response. For more information, see Status Code. Default value: None
reason	str	Explanation: Reason description. Default value: None
errorCode	str	Explanation: Error code returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
errorMessage	str	Explanation: Error message returned by the OBS server. If the value of status is less than 300, this parameter is left blank. Default value: None
requestId	str	Explanation: Request ID returned by the OBS server Default value: None
indicator	str	Explanation: Error indicator returned by the OBS server. Default value: None
hostId	str	Explanation: Requested server ID. If the value of status is less than 300, this parameter is left blank. Default value: None
resource	str	Explanation: Error source (a bucket or an object). If the value of status is less than 300, this parameter is left blank. Default value: None
header	list	Explanation: Response header list, composed of tuples. Each tuple consists of two elements, respectively corresponding to the key and value of a response header. Default value: None
body	object	Explanation: Result content returned after the operation is successful. If the value of status is larger than 300, the value of body is null. The value varies with the API being called. For details, see Bucket-Related APIs (SDK for Python) and Object-Related APIs (SDK for Python). Default value: None

**Table 4** GetResult.body
GetResult.body Type	Description
GetBucketStorageInfoResponse	Explanation: Response result of the request for obtaining storage information about a bucket

**Table 5** GetBucketStorageInfoResponse
Parameter	Type	Description
size	long	Explanation: Bucket size Default value: None
objectNumber	int	Explanation: Number of objects in the bucket Default value: None
standardSize	long	Explanation: Size of Standard objects Default value: None
standardObjectNumber	int	Explanation: Number of Standard objects Default value: None
warmSize	long	Explanation: Size of Infrequent Access objects Default value: None
warmObjectNumber	int	Explanation: Number of Infrequent Access objects Default value: None
coldSize	long	Explanation: Size of Archive objects Default value: None
coldObjectNumber	int	Explanation: Number of Archive objects Default value: None
deepArchiveSize	long	Explanation: Size of objects Default value: None
deepArchiveObjectNumber	int	Explanation: Number of objects Default value: None

Code Examples

This example returns the storage information of bucket examplebucket.

    
     
       
       
         from obs import ObsClient
import os
import traceback

# Obtain an AK and SK pair using environment variables or import the AK and SK pair in other ways. Using hard coding may result in leakage.
# Obtain an AK and SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
ak = os.getenv("AccessKeyID")
sk = os.getenv("SecretAccessKey")
# (Optional) If you use a temporary AK and SK pair and a security token to access OBS, obtain them from environment variables.
# security_token = os.getenv("SecurityToken")
# Set server to the endpoint corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one in use.
server = "https://obs.ap-southeast-1.myhuaweicloud.com" 

# Create an obsClient instance.
# If you use a temporary AK and SK pair and a security token to access OBS, you must specify security_token when creating an instance.
obsClient = ObsClient(access_key_id=ak, secret_access_key=sk, server=server)
try:
    bucketName="examplebucket"
    # Obtain bucket storage information.
    resp = obsClient.getBucketStorageInfo(bucketName)
    # If status code 2xx is returned, the API is called successfully. Otherwise, the API call fails.
    if resp.status < 300:
        print('Get Bucket StorageInfo Succeeded')
        print('requestId:', resp.requestId)
        print('size:', resp.body.size)
        print('objectNumber:', resp.body.objectNumber)
    else:
        print('Get Bucket StorageInfo Failed')
        print('requestId:', resp.requestId)
        print('errorCode:', resp.errorCode)
        print('errorMessage:', resp.errorMessage)
except:
    print('Get Bucket StorageInfo Failed')
    print(traceback.format_exc())

        

      

    
   