tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Cloud Object Storage
    Documentation
    Download PDF

    Access Control

    Last updated: 2024-02-02 14:36:36
    Download PDF

      Overview

      This document provides an overview of APIs and SDK code samples related to the access control lists (ACLs) for buckets and objects.
      Bucket ACL
      API
      Operation
      Description
      Setting a bucket ACL
      Sets an ACL for a bucket
      Querying a bucket ACL
      Queries the ACL of a bucket
      Object ACL
      API
      Operation
      Description
      Setting an object ACL
      Sets an ACL for an object in a bucket
      Querying an object ACL
      Queries the ACL of an object

      Bucket ACL

      Setting a bucket ACL

      Description

      This API is used to set an access control list (ACL) for a specified bucket.

      Sample code

      try
      {
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        PutBucketACLRequest request = new PutBucketACLRequest(bucket);
        // Set private read and write permissions
        request.SetCosACL(CosACL.Private);
        // Grant read permission for account 1131975903
        COSXML.Model.Tag.GrantAccount readAccount = new COSXML.Model.Tag.GrantAccount();
        readAccount.AddGrantAccount("1131975903", "1131975903");
        request.SetXCosGrantRead(readAccount);
        // Execute the request
        PutBucketACLResult result = cosXml.PutBucketACL(request);
        // Request succeeded
        Console.WriteLine(result.GetResultInfo());
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.

      Querying a bucket ACL

      Description

      This API is used to query the access control list (ACL) of a specified bucket.

      Sample code

      try
      {
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        GetBucketACLRequest request = new GetBucketACLRequest(bucket);
        // Execute the request
        GetBucketACLResult result = cosXml.GetBucketACL(request);
        // Bucket ACL information
        AccessControlPolicy acl = result.accessControlPolicy;
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.

      Object ACL

      Setting an object ACL

      Description

      This API is used to set the access control list (ACL) for an object in a bucket.

      Sample code

      // To avoid reaching the upper limit of 1,000 bucket ACLs,
      // we do not recommend setting an object ACL for a single object unless absolutely necessary. The object will inherit bucket permissions by default.
      try
      {
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        string key = "exampleobject"; // Object key
        PutObjectACLRequest request = new PutObjectACLRequest(bucket, key);
        // Set private read and write permissions 
        request.SetCosACL(CosACL.Private);
        // Grant read permission for account 1131975903 
        COSXML.Model.Tag.GrantAccount readAccount = new COSXML.Model.Tag.GrantAccount();
        readAccount.AddGrantAccount("1131975903", "1131975903");
        request.SetXCosGrantRead(readAccount);
        // Execute the request
        PutObjectACLResult result = cosXml.PutObjectACL(request);
        // Request succeeded
        Console.WriteLine(result.GetResultInfo());
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.

      Querying an object ACL

      Description

      This API is used to query the ACL of an object.

      Sample code

      try
      {
        // Bucket name in the format of bucketname-APPID. You can get APPID by referring to https://console.tencentcloud.com/developer.
        string bucket = "examplebucket-1250000000";
        string key = "exampleobject"; // Object key
        GetObjectACLRequest request = new GetObjectACLRequest(bucket, key);
        // Execute the request
        GetObjectACLResult result = cosXml.GetObjectACL(request);
        // Object ACL information
        AccessControlPolicy acl = result.accessControlPolicy;
      }
      catch (COSXML.CosException.CosClientException clientEx)
      {
        // Request failed
        Console.WriteLine("CosClientException: " + clientEx);
      }
      catch (COSXML.CosException.CosServerException serverEx)
      {
        // Request failed
        Console.WriteLine("CosServerException: " + serverEx.GetInfo());
      }
      Note:
      For more samples, please visit GitHub.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy