Help Center/ Object Storage Service/ SDK Reference/ Go/ Buckets (SDK for Go)/ Obtaining the Bucket ACL (SDK for Go)
Updated on 2024-12-09 GMT+08:00

Obtaining the Bucket ACL (SDK for Go)

Function

OBS provides access control over buckets. You can use an access policy to define whether a user can perform certain operations on a specific bucket. OBS access control can be implemented using IAM permissions, bucket policies, and ACLs (including bucket and object ACLs). For more information, see Introduction to OBS Access Control.

A bucket ACL applies permissions to another Huawei Cloud account and its IAM users, rather than the current account and its IAM users. It can grant access to both a bucket (including the objects in it) and the bucket ACL. The granted access includes view and edit permissions. You must specify a bucket name when configuring a bucket ACL. For more information, see ACLs.

This API returns the ACL of a bucket.

Restrictions

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. For more information, see Status Code.

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 returns the ACL information of bucket examplebucket.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main
import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/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. 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/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 corresponding to the bucket. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // 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)
    }
}