Obtaining a Bucket Storage Quota¶
Function¶
This API returns the storage quota (upper limit of the storage capacity) of a bucket. If the quota is 0, there is no upper limit on the bucket capacity.
Restrictions¶
A bucket storage quota must be a non-negative integer expressed in bytes. The maximum value is as follows: 263 - 1.
A frozen bucket owner (due to account in arrears) is not allowed to query the bucket storage quota.
To obtain the storage quota of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketQuota in IAM or GetBucketQuota in a bucket policy).
Method¶
func (obsClient ObsClient) GetBucketQuota(bucketName string) (output *GetBucketQuotaOutput, err error)
Request Parameters¶
Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
bucketName | string | Yes | Explanation: Bucket name Restrictions:
Default value: None |
Responses¶
Parameter | Type | Description |
|---|---|---|
output | Explanation: Returned results. For details, see Table 3. | |
err | error | Explanation: Error messages returned by the API |
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 |
Quota | int64 | Explanation: Bucket storage quota Value range: 0 to (263 - 1), in bytes Default value: 0, indicating that there is no limit on the bucket quota. |
Code Examples¶
This example returns the quota of bucket examplebucket.
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 the bucket quota.
output, err := obsClient.GetBucketQuota(bucketname)
if err == nil {
fmt.Printf("Get bucket(%s)'s quota successful!\n", bucketname)
fmt.Printf("RequestId:%s\n", output.RequestId)
fmt.Printf("Quota:%d\n", output.Quota)
return
}
fmt.Printf("Get bucket(%s)'s quota 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)
}
}