tencent cloud

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
PUT Bucket acl	Setting a bucket ACL	Sets an ACL for a bucket
GET Bucket acl	Querying a bucket ACL	Queries the ACL of a bucket

Object ACL

API	Operation	Description
PUT Object acl	Setting an object ACL	Sets an ACL for an object in a bucket
GET Object acl	Querying an object ACL	Queries the ACL of an object

SDK API References

For parameters and method description of all APIs in the SDK, please see SDK API Reference.

Bucket ACL

Setting a bucket ACL

Description

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

Sample code

Objective-C

QCloudPutBucketACLRequest* putACL = [QCloudPutBucketACLRequest new];
// ID of the authorized account
NSString* uin = @"100000000001";
NSString *ownerIdentifier = [NSString stringWithFormat:@"qcs::cam::uin/%@:uin/%@"
                            , uin,uin];
NSString *grantString = [NSString stringWithFormat:@"id=\"%@\"",ownerIdentifier];
// Grant read and write permission
putACL.grantFullControl = grantString;
// Grant read permission
putACL.grantRead = grantString;
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
putACL.bucket = @"examplebucket-1250000000";
[putACL setFinishBlock:^(id outputObject, NSError *error) {
   // You can get the headers returned by the server from outputObject
   NSDictionary * result = (NSDictionary *)outputObject;
}];
// Set an ACL
[[QCloudCOSXMLService defaultCOSXML] PutBucketACL:putACL];

Note：

For the complete sample, go to GitHub.

Swift

let putBucketACLReq = QCloudPutBucketACLRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
putBucketACLReq.bucket = "examplebucket-1250000000";
// ID of the authorized account
let appTD = "100000000001";
let ownerIdentifier = "qcs::cam::uin/\(appTD):uin/\(appTD)";
let grantString = "id=\"\(ownerIdentifier)\"";
// Grants write permission
putBucketACLReq.grantWrite = grantString;
// Grant read permission
putBucketACLReq.grantRead = grantString;
// Grant full control (read and write permission) grantFullControl == grantRead + grantWrite
putBucketACLReq.grantFullControl = grantString;
putBucketACLReq.finishBlock = {(result,error) in
   if let result = result {
       // You can get the header information returned by the server from `result`
   } else {
       print(error!)
   }
}
QCloudCOSXMLService.defaultCOSXML().putBucketACL(putBucketACLReq);

Note：

For the complete sample, go to GitHub.

Querying a bucket ACL

Description

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

Sample code

Objective-C

QCloudGetBucketACLRequest* getBucketACl = [QCloudGetBucketACLRequest new];
// Bucket name in the format: `BucketName-APPID`
getBucketACl.bucket = @"examplebucket-1250000000";
[getBucketACl setFinishBlock:^(QCloudACLPolicy * _Nonnull result,
                                      NSError * _Nonnull error) {
   // The authorized account and granted permissions
   QCloudAccessControlList *acl = result.accessControlList;
}];
[[QCloudCOSXMLService defaultCOSXML] GetBucketACL:getBucketACl];

Note：

For the complete sample, go to GitHub.

Swift

let getBucketACLReq = QCloudGetBucketACLRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
getBucketACLReq.bucket = "examplebucket-1250000000";
getBucketACLReq.setFinish { (result, error) in
   if let result = result {
       // ACL authorization information
       let acl = result.accessControlList;
   } else {
       print(error!)
   }
}
QCloudCOSXMLService.defaultCOSXML().getBucketACL(getBucketACLReq)

Note：

For the complete sample, go to 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

Objective-C

QCloudPutObjectACLRequest* request = [QCloudPutObjectACLRequest new];
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
request.object = @"exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
NSString *grantString = [NSString stringWithFormat:@"id=\"%@\"",@"100000000001"];
// grantFullControl grants both read and write permission
// Grant read and write permission
request.grantFullControl = grantString;
// Grant read permission
request.grantRead = grantString;
[request setFinishBlock:^(id outputObject, NSError *error) {
   // outputObject contains information such as the ETag or custom headers in the response.
   NSDictionary* info = (NSDictionary *) outputObject;
}];
[[QCloudCOSXMLService defaultCOSXML] PutObjectACL:request];

Note：

For the complete sample, go to GitHub.

Swift

let putObjectACl = QCloudPutObjectACLRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
putObjectACl.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
putObjectACl.object = "exampleobject";
let grantString = "id=\"100000000001\"";
// grantFullControl grants both read and write permission
putObjectACl.grantFullControl = grantString;
// Grant read permission
putObjectACl.grantRead = grantString;

putObjectACl.finishBlock = {(result,error)in
   if let result = result {
       // "result" contains response headers.
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().putObjectACL(putObjectACl);

Note：

For the complete sample, go to GitHub.

Querying an object ACL

Description

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

Sample code

Objective-C

QCloudGetObjectACLRequest *request = [QCloudGetObjectACLRequest new];
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
request.object = @"exampleobject";
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
request.bucket = @"examplebucket-1250000000";
__block QCloudACLPolicy* policy;
[request setFinishBlock:^(QCloudACLPolicy * _Nonnull result,
                         NSError * _Nonnull error) {

   policy = result;
   // result.accessControlList; the authorized user and granted permissions
   // result.owner; the object owner
}];
[[QCloudCOSXMLService defaultCOSXML] GetObjectACL:request];

Note：

For the complete sample, go to GitHub.

Swift

let getObjectACL = QCloudGetObjectACLRequest.init();
// Bucket name in the format of BucketName-Appid, which can be viewed in the COS console at https://console.intl.cloud.tencent.com/cos5/bucket
getObjectACL.bucket = "examplebucket-1250000000";
// Object key, i.e. the full path of a COS object. If the object is in a directory, the path should be "video/xxx/movie.mp4"
getObjectACL.object = "exampleobject";
getObjectACL.setFinish { (result, error) in
   if let result = result {
       // Object authorization information
       let acl = result.accessControlList
   } else {
       print(error!);
   }
}
QCloudCOSXMLService.defaultCOSXML().getObjectACL(getObjectACL);

Note：

For the complete sample, go to GitHub.