Obtaining the Policy of a Bucket¶
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.
A bucket policy is applied to a configured bucket and the objects in it. You can use a bucket policy to grant permissions for the bucket and the objects in it to IAM users or other accounts. If you want IAM users to have different permissions for different buckets, you can configure required bucket policies.
This API returns the policy of a bucket.
Restrictions¶
OBS returns "404 NoSuchBucketPolicy" when you call this API in the following scenarios:
The specified bucket policy does not exist.
Access to the specified bucket is denied.
To obtain the policy of a bucket, you must be the bucket owner or have the required permission (obs:bucket:GetBucketPolicy in IAM or GetBucketPolicy in a bucket policy).
Method¶
func (obsClient ObsClient) GetBucketPolicy(bucketName string) (output *GetBucketPolicyOutput, 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 |
Policy | string | Explanation: Policy information in JSON format Restrictions:
Default value: None |
Code Examples¶
This example returns the policy of bucket bucketname.
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 policy.
output, err := obsClient.GetBucketPolicy(bucketname)
if err == nil {
fmt.Printf("Get policy successful with bucket:%s!\n", bucketname)
fmt.Printf("RequestId:%s\n", output.RequestId)
fmt.Printf("Policy:%s\n", output.Policy)
return
}
fmt.Printf("Get policy fail with bucket:%s!\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)
}
}