Obtaining the Bucket ACL¶

Function¶

Access control lists (ACLs) allow resource owners to grant other accounts the permissions to access resources. By default, only the resource owner has full control over resources when a bucket or object is created. That is, the bucket creator has full control over the bucket, and the object uploader has full control over the object. Other accounts do not have the permissions to access resources. If resource owners want to grant other accounts the read and write permissions on resources, they can use ACLs. ACLs grant permissions to accounts. After an account is granted permissions, both the account and its IAM users can access the resources.

This API returns the ACL of a bucket.

Restrictions¶

To obtain the ACL of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketAcl in IAM or GetBucketAcl in a bucket policy).

Method¶

func (obsClient ObsClient) GetBucketAcl(bucketName string) (output *GetBucketAclOutput, 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	*GetBucketAclOutput	Explanation: Returned results. For details, see Table 3.
err	error	Explanation: Error messages returned by the API

**Table 3** GetBucketAclOutput¶
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
Owner	Owner	Explanation: Bucket owner. For details, see Table 4.
Grants	Grant	Explanation: Grantees' permission information. For details, see Table 5.

**Table 4** Owner¶
Parameter	Type	Mandatory (Yes/No)	Description
ID	string	Yes if used as a request parameter	Explanation: Account (domain) ID of the owner Value range: To obtain the account ID, see How Do I Get My Account ID and User ID? Default value: None

**Table 5** Grant¶
Parameter	Type	Description
Grantee	Grantee	Explanation: Grantee information. For details, see Table 6.
Permission	PermissionType	Explanation: Granted permission. For details, see Table 9.

**Table 6** Grantee¶
Parameter	Type	Description
Type	GranteeType	Explanation: Grantee type Value range: See Table 7. Default value: None
ID	string	Explanation: Account (domain) ID of the grantee Value range: To obtain the account ID, see How Do I Get My Account ID and User ID? Default value: None
DisplayName	string	Explanation: Account name of the grantee Restrictions: Starts with a letter. Contains 6 to 32 characters. Contains only letters, digits, hyphens (-), or underscores (_). Default value: None
URI	GroupUriType	Explanation: Authorized user group Value range: See Table 8. Default value: None

**Table 7** GranteeType¶
Constant	Default Value	Description
GranteeGroup	Group	User group
GranteeUser	CanonicalUser	Individual user

**Table 8** GroupUriType¶
Constant	Default Value	Description
GroupAllUsers	AllUsers	All users

**Table 9** PermissionType¶
Constant	Default Value	Description
PermissionRead	READ	Read permission
PermissionWrite	WRITE	Write permission
PermissionReadAcp	READ_ACP	Permission to read ACL configurations
PermissionWriteAcp	WRITE_ACP	Permission to modify ACL configurations
PermissionFullControl	FULL_CONTROL	Full control access, including read and write permissions for a bucket and its ACL, or for an object and its ACL.

Code Examples¶

This example shows how to obtain the ACL of the examplebucket bucket.

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.WithSignature(obs.SignatureObs)/*, obs.WithSecurityToken(securityToken)*/)
    if err != nil {
        fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    // Specify a bucket name.
    bucketname := "examplebucket"
    // Obtain the bucket ACL.
    output, err := obsClient.GetBucketAcl(bucketname)
    if err == nil {
        fmt.Printf("Get bucket(%s)'s acl rules successful!\n", bucketname)
        fmt.Printf("RequestId:%s\n", output.RequestId)
        fmt.Printf("Owner.ID:%s\n", output.Owner.ID)
        for index, grant := range output.Grants {
            fmt.Printf("Grant[%d]-Type:%s, ID:%s, URI:%s, Permission:%s\n",
                index, grant.Grantee.Type, grant.Grantee.ID, grant.Grantee.URI, grant.Permission)
        }
        return
    }
    fmt.Printf("Get bucket(%s)'s acl rules 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