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

Object ACL

Bucket ACL

Setting a bucket ACL

Description

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

Method prototype

public Guzzle\Service\Resource\Model putBucketAcl(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->putBucketAcl(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
      'ACL' => 'private',
      'Grants' => array(
          array(
              'Grantee' => array(
                  'DisplayName' => 'qcs::cam::uin/100000000001:uin/100000000001',
                  'ID' => 'qcs::cam::uin/100000000001:uin/100000000001',
                  'Type' => 'CanonicalUser',
              ),  
              'Permission' => 'FULL_CONTROL',
          ),  
          // ... repeated
      ),  
      'Owner' => array(
          'DisplayName' => 'qcs::cam::uin/100000000001:uin/100000000001',
          'ID' => 'qcs::cam::uin/100000000001:uin/100000000001',
      )));
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo "$e\n";
}

Parameter description

Querying a bucket ACL

Description

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

Method prototype

public Guzzle\Service\Resource\Model getBucketAcl(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->getBucketAcl(array(
      'Bucket' => 'examplebucket-1250000000' // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
  )); 
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Sample response

Array
(
  [data:protected] => Array
      (
        [Owner] => Array
            (
               [ID] => qcs::cam::uin/100000000001:uin/100000000001
               [DisplayName] => qcs::cam::uin/100000000001:uin/100000000001
            )
         [Grants] => Array
              (
                [0] => Array
                    (
                      [Grantee] => Array
                         (
                           [ID] => qcs::cam::uin/100000000001:uin/100000000001
                           [DisplayName] => qcs::cam::uin/100000000001:uin/100000000001
                         )
                       [Permission] => FULL_CONTROL
                    )
               )
         [RequestId] => NWE3YzhjMTRfYzdhMzNiMGFfYjdiOF8yYzZmMzU=
      )
)

Response description

Object ACL

Setting an object ACL

Description

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

Method prototype

public Guzzle\Service\Resource\Model putObjectAcl(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));
try {
  $result = $cosClient->putObjectAcl(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
      'Key' => 'exampleobject',
      'ACL' => 'private',
      'Grants' => array(
          array(
              'Grantee' => array(
                  'DisplayName' => 'qcs::cam::uin/100000000001:uin/100000000001',
                  'ID' => 'qcs::cam::uin/100000000001:uin/100000000001',
                  'Type' => 'CanonicalUser',
              ),  
              'Permission' => 'FULL_CONTROL',
          ),  
          // ... repeated
      ),  
      'Owner' => array(
          'DisplayName' => 'qcs::cam::uin/100000000001:uin/100000000001',
          'ID' => 'qcs::cam::uin/100000000001:uin/100000000001',
      )));
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo "$e\n";
}

Parameter description

Querying an object ACL

Description

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

Method prototype

public Guzzle\Service\Resource\Model getObjectAcl(array $args = array());

Sample request

<?php
require dirname(__FILE__) . '/../vendor/autoload.php';
$secretId = "SECRETID"; //Replace it with the actual SecretId, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //Replace it with the actual SecretKey, which can be viewed and managed at https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //Replace it with the actual region, which can be viewed in the console at https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\Cos\Client(
  array(
      'region' => $region,
      'schema' => 'https', // Protocol header, which is http by default
      'credentials'=> array(
          'secretId'  => $secretId ,
          'secretKey' => $secretKey)));

try {
  $result = $cosClient->getObjectAcl(array(
      'Bucket' => 'examplebucket-1250000000', // Bucket name in the format of `BucketName-APPID`, which can be viewed in the COS console at https://console.cloud.tencent.com/cos5/bucket
      'Key' => 'exampleobject',
  )); 
  // Request succeeded
  print_r($result);
} catch (\Exception $e) {
  // Request failed
  echo($e);
}

Sample response

Array
(
  [data:protected] => Array
      (
          [Owner] => Array
              (
                  [ID] => qcs::cam::uin/100000000001:uin/100000000001
                  [DisplayName] => qcs::cam::uin/100000000001:uin/100000000001
              )
           [Grants] => Array
              (
                  [0] => Array
                      (
                          [Grantee] => Array
                              (
                                  [ID] => qcs::cam::uin/100000000001:uin/100000000001
                                  [DisplayName] => qcs::cam::uin/100000000001:uin/100000000001
                              )
                           [Permission] => FULL_CONTROL
                      )
               )
           [RequestId] => NWE3YzhjMTRfYzdhMzNiMGFfYjdiOF8yYzZmMzU=
      )
)

Response description