开发者指南

API 文档

SDK 文档

访问控制

最近更新时间:2020-08-20 15:52:42

简介

本文档提供关于存储桶、对象的访问控制列表(ACL)的相关 API 概览以及 SDK 示例代码。

存储桶 ACL

API 操作名 操作描述
PUT Bucket acl 设置存储桶 ACL 设置指定存储桶的访问权限控制列表(ACL)
GET Bucket acl 查询存储桶 ACL 查询指定存储桶的访问权限控制列表(ACL)

对象 ACL

API 操作名 操作描述
PUT Object acl 设置对象 ACL 设置存储桶中某个对象的访问控制列表
GET Object acl 查询对象 ACL 查询对象的访问控制列表

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

存储桶 ACL

设置存储桶 ACL

功能说明

设置指定存储桶的访问权限控制列表(ACL)。

示例代码

Objective-C

QCloudPutBucketACLRequest* putACL = [QCloudPutBucketACLRequest new];

// 授予权限的账号 ID
NSString* uin = @"100000000001";
NSString *ownerIdentifier = [NSString stringWithFormat:@"qcs::cam::uin/%@:uin/%@"
                             , uin,uin];
NSString *grantString = [NSString stringWithFormat:@"id=\"%@\"",ownerIdentifier];

// 赋予被授权者读写权限
putACL.grantFullControl = grantString;

// 赋予被授权者读权限
putACL.grantRead = grantString;

// 赋予被授权者写权限
putACL.grantWrite = grantString;

// 存储桶名称,格式为 BucketName-APPID
putACL.bucket = @"examplebucket-1250000000";

[putACL setFinishBlock:^(id outputObject, NSError *error) {
    // 可以从 outputObject 中获取服务器返回的 header 信息
    NSDictionary * result = (NSDictionary *)outputObject;

}];
// 设置acl
[[QCloudCOSXMLService defaultCOSXML] PutBucketACL:putACL];
说明:

更多完整示例,请前往 GitHub 查看。

Swift

let putBucketACLReq = QCloudPutBucketACLRequest.init();

// 存储桶名称,格式为 BucketName-APPID
putBucketACLReq.bucket = "examplebucket-1250000000";

// 授予权限的账号 ID
let appTD = "100000000001";
let ownerIdentifier = "qcs::cam::uin/\(appTD):uin/\(appTD)";
let grantString = "id=\"\(ownerIdentifier)\"";
// 赋予被授权者写权限
putBucketACLReq.grantWrite = grantString;

// 赋予被授权者读权限
putBucketACLReq.grantRead = grantString;

// 赋予被授权者读写权限 grantFullControl == grantRead + grantWrite
putBucketACLReq.grantFullControl = grantString;

putBucketACLReq.finishBlock = {(result,error) in
    if let result = result {
        // 可以从 result 中获取服务器返回的 header 信息
    } else {
        print(error!)
    }
}
QCloudCOSXMLService.defaultCOSXML().putBucketACL(putBucketACLReq);
说明:

更多完整示例,请前往 GitHub 查看。

查询存储桶 ACL

功能说明

查询指定存储桶的访问权限控制列表(ACL)。

示例代码

Objective-C

QCloudGetBucketACLRequest* getBucketACl = [QCloudGetBucketACLRequest new];

// 存储桶名称,格式:BucketName-APPID
getBucketACl.bucket = @"examplebucket-1250000000";

[getBucketACl setFinishBlock:^(QCloudACLPolicy * _Nonnull result,
                                       NSError * _Nonnull error) {
    // 被授权者与权限的信息
    QCloudAccessControlList *acl = result.accessControlList;
}];

[[QCloudCOSXMLService defaultCOSXML] GetBucketACL:getBucketACl];
说明:

更多完整示例,请前往 GitHub 查看。

Swift

let getBucketACLReq = QCloudGetBucketACLRequest.init();

// 存储桶名称,格式为 BucketName-APPID
getBucketACLReq.bucket = "examplebucket-1250000000";

getBucketACLReq.setFinish { (result, error) in
    if let result = result {
        // ACL 授权信息
        let acl = result.accessControlList;
    } else {
        print(error!)
    }
}
QCloudCOSXMLService.defaultCOSXML().getBucketACL(getBucketACLReq)
说明:

更多完整示例,请前往 GitHub 查看。

对象 ACL

设置对象 ACL

功能说明

设置存储桶中某个对象的访问控制列表(ACL)。

示例代码

Objective-C

QCloudPutObjectACLRequest* request = [QCloudPutObjectACLRequest new];

// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = @"exampleobject";

// 存储桶名称,格式为 BucketName-APPID
request.bucket = @"examplebucket-1250000000";

NSString *grantString = [NSString stringWithFormat:@"id=\"%@\"",@"100000000001"];

// grantFullControl 等价于 grantRead + grantWrite
// 赋予被授权者读写权限。
request.grantFullControl = grantString;
// 赋予被授权者读权限。
request.grantRead = grantString;
// 赋予被授权者写权限。
request.grantWrite = grantString;

[request setFinishBlock:^(id outputObject, NSError *error) {
    // 可以从 outputObject 中获取 response 中 etag 或者自定义头部等信息
    NSDictionary* info = (NSDictionary *) outputObject;
}];

[[QCloudCOSXMLService defaultCOSXML] PutObjectACL:request];
说明:

更多完整示例,请前往 GitHub 查看。

Swift

let putObjectACl = QCloudPutObjectACLRequest.init();

// 存储桶名称,格式为 BucketName-APPID
putObjectACl.bucket = "examplebucket-1250000000";

// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
putObjectACl.object = "exampleobject";
let grantString = "id=\"100000000001\"";

// grantFullControl 等价于 grantRead + grantWrite
putObjectACl.grantFullControl = grantString;
// 赋予被授权者读权限。
putObjectACl.grantRead = grantString;


putObjectACl.finishBlock = {(result,error)in
    if let result = result {
        // result 包含响应的 header 信息
    } else {
        print(error!);
    }
}
QCloudCOSXMLService.defaultCOSXML().putObjectACL(putObjectACl);
说明:

更多完整示例,请前往 GitHub 查看。

查询对象 ACL

功能说明

查询对象的访问控制列表。

示例代码

Objective-C

QCloudGetObjectACLRequest *request = [QCloudGetObjectACLRequest new];

// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = @"exampleobject";

// 存储桶名称,格式为 BucketName-APPID
request.bucket = @"examplebucket-1250000000";

__block QCloudACLPolicy* policy;
[request setFinishBlock:^(QCloudACLPolicy * _Nonnull result,
                          NSError * _Nonnull error) {

    policy = result;
    // result.accessControlList; 被授权者与权限的信息
    // result.owner; 持有者的信息
}];

[[QCloudCOSXMLService defaultCOSXML] GetObjectACL:request];
说明:

更多完整示例,请前往 GitHub 查看。

Swift

let getObjectACL = QCloudGetObjectACLRequest.init();

// 存储桶名称,格式为 BucketName-APPID
getObjectACL.bucket = "examplebucket-1250000000";

// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
getObjectACL.object = "exampleobject";
getObjectACL.setFinish { (result, error) in
    if let result = result {
        // 对象授权信息
        let acl = result.accessControlList
    } else {
        print(error!);
    }
}
QCloudCOSXMLService.defaultCOSXML().getObjectACL(getObjectACL);
说明:

更多完整示例,请前往 GitHub 查看。

目录