Overview

This document provides an overview of APIs and SDK code samples related to bucket policies.

Setting a Bucket Policy

Feature description

This API (PUT Bucket policy) is used to write a permission policy for a bucket. The policy passed to this API will overwrite the existing one (if any) in the bucket.

Method prototype

func (s *BucketService) PutPolicy(ctx context.Context, opt *BucketPutPolicyOptions) (*Response, error)

Sample request

opt := &cos.BucketPutPolicyOptions{
    Version: "2.0",
    Statement: []cos.BucketStatement{
    {
        Principal: map[string][]string{
            "qcs": []string{
                "qcs::cam::uin/100000000001:uin/100000000011", // Replace with the uin of the account to be granted the permission.
            },
        },
        Action: []string{
            "name/cos:GetObject",
        },
        Effect: "allow",
        Resource: []string{
            // Change it to the allowed path prefix (such as "a.jpg", "a/*", or "*"). You can determine the upload path based on your login status. (Keep in mind that using asterisks (*) could bring high risks.)
            "qcs::cos:ap-guangzhou:uid/1250000000:examplebucket-1250000000/exampleobject",
        },
        Condition: map[string]map[string]interface{}{
            "ip_not_equal": map[string]interface{}{
                "qcs:ip": []string{
                    "192.168.1.1",
                },
            },
        },
    },
    },
}
_, err := c.Bucket.PutPolicy(context.Background(), opt)

Parameter description

type BucketStatement struct {
    Principal map[string][]string
    Action    []string
    Effect    string
    Resource  []string
    Condition map[string]map[string]interface{}
}

type BucketPutPolicyOptions struct {
    Statement []BucketStatement
    Version   string
    Principal map[string][]string
}

Querying a Bucket Policy

Feature description

This API (GET Bucket policy) is used to read the permission policy of a bucket.

Method prototype

func (s *BucketService) GetPolicy(ctx context.Context) (*BucketGetPolicyResult, *Response, error)

Sample request

res, resp, err := c.Bucket.GetPolicy(context.Background())

Response description

type BucketGetPolicyResult BucketPutPolicyOptions
// For more information, please see `BucketPutPolicyOptions`.

Deleting a Bucket Policy

Feature description

This API (DELETE Bucket policy) is used to delete the permission policy of a bucket.

Method prototype

func (s *BucketService) DeletePolicy(ctx context.Context) (*Response, error)

Sample request

resp, err := c.Bucket.DeletePolicy(context.Background())