Obtaining Storage Information of a Bucket¶

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.

Note

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

Method¶

func (obsClient ObsClient) GetBucketStorageInfo(bucketName string) (output *GetBucketStorageInfoOutput, err error)

Request Parameters¶

**Table 1** List of request parameters¶
Parameter	Type	Mandatory (Yes/No)	Description
bucketName	string	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 a period (.) and a hyphen (-) 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 attributes comply with those set in the first creation request. Default value: None

Responses¶

**Table 2** List of returned results¶
Parameter	Type	Description
output	*GetBucketStorageInfoOutput	Explanation: Returned results. For details, see Table 3.
err	error	Explanation: Error messages returned by the API

**Table 3** GetBucketStorageInfoOutput¶
Parameter	Type	Description
StatusCode	int	Explanation: HTTP status code Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. Default value: None
RequestId	string	Explanation: Request ID returned by the OBS server Default value: None
ResponseHeaders	map[string][]string	Explanation: HTTP response headers Default value: None
Size	int64	Explanation: Size of the space occupied by objects in the bucket Value range: 0 to (2⁶³ - 1), in bytes
ObjectNumber	int	Explanation: Number of objects in the bucket Value range: An integer from 0 to (2³¹ - 1) Default value: None

Code Examples¶

This example returns the storage information of bucket examplebucket, including the number of objects and the space occupied by objects.

package main
import (
    "fmt"
    "os"
    "obs-sdk-go/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding to reduce leakage risks. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    // securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint of the region where the bucket locates.
    endPoint := "https://your-endpoint"
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    obsClient, err := obs.New(ak, sk, endPoint/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    // Specify a bucket name.
    bucketname := "examplebucket"
    // Obtain bucket storage information.
    output, err := obsClient.GetBucketStorageInfo(bucketname)
    if err == nil {
        fmt.Printf("Get bucket(%s)'s storage-info successful!\n", bucketname)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        fmt.Printf("Size:%d, ObjectNumber:%d\n", output.Size, output.ObjectNumber)
        return
    }
    fmt.Printf("Get bucket(%s)'s storage-info fail!\n", bucketname)
    if obsError, ok := err.(obs.ObsError); ok {
        fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
        fmt.Println(obsError.Error())
    } else {
        fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
        fmt.Println(err)
    }
}

last updated: 2025-08-28 14:06 UTC - commit: 39882e2dd8910deda6bee60c54bef141ea2cac76