动态与公告

产品动态

产品公告

产品简介

产品概述

功能概览

应用场景

产品优势

基本概念

地域和访问域名

规格与限制

产品计费

计费概述

计费方式

计费项

免费额度

计费示例

查看和下载账单

欠费说明

常见问题

快速入门

控制台快速入门

COSBrowser 快速入门

用户指南

创建请求

存储桶

对象

数据管理

批量处理

全球加速

监控与告警

运维中心

数据处理

内容审核

智能工具箱

数据工作流

应用集成

工具指南

工具概览

环境安装与配置

COSBrowser 工具

COSCLI 工具

COSCMD 工具

COS Migration 工具

FTP Server 工具

Hadoop 工具

COSDistCp 工具

HDFS TO COS 工具

GooseFS-Lite 工具

在线辅助工具

自助诊断工具

实践教程

概览

访问控制与权限管理

性能优化

使用 AWS S3 SDK 访问 COS

数据容灾备份

域名管理实践

图片处理实践

COS 音视频播放器实践

工作流实践

数据直传

内容审核实践

数据安全

数据校验

大数据实践

COS 成本优化解决方案

在第三方应用中使用 COS

迁移指南

本地数据迁移至 COS

第三方云存储数据迁移至 COS

以 URL 作为源地址的数据迁移至 COS

COS 之间数据迁移

Hadoop 文件系统与 COS 之间的数据迁移

数据湖存储

云原生数据湖

元数据加速

数据加速器 GooseFS

数据处理

数据处理概述

图片处理

媒体处理

内容审核

文件处理

文档处理

故障处理

获取 RequestId 操作指引

通过外网上传文件至 COS 缓慢

访问 COS 时返回403错误码

资源访问异常

POST Object 常见异常

API 文档

简介

公共请求头部

公共响应头部

错误码

请求签名

操作列表

Service 接口

Bucket 接口

Object 接口

批量处理接口

数据处理接口

任务与工作流

内容审核接口

云查毒接口

SDK 文档

SDK 概览

准备工作

Android SDK

C SDK

C++ SDK

.NET(C#) SDK

Flutter SDK

Go SDK

iOS SDK

Java SDK

JavaScript SDK

Node.js SDK

PHP SDK

Python SDK

React Native SDK

小程序 SDK

错误码

鸿蒙(Harmony) SDK

终端 SDK 质量优化

安全与合规

数据容灾

数据安全

访问管理

常见问题

热门问题

一般性问题

计费计量问题

域名合规问题

存储桶配置问题

域名和 CDN 问题

文件操作问题

日志监控问题

权限管理问题

数据处理问题

数据安全问题

预签名 URL 问题

SDK 类问题

工具类问题

API 类问题

服务协议

Service Level Agreement

隐私政策

数据处理和安全协议

联系我们

词汇表

访问控制

PDF

聚焦模式

字号

最后更新时间： 2024-01-22 11:43:35

简介
本文档提供关于存储桶、对象的访问控制列表（ACL）的相关 API 概览以及 SDK 示例代码。
存储桶 ACL
API
操作名
操作描述
PUT Bucket acl
设置存储桶 ACL
设置指定存储桶的访问权限控制列表
GET Bucket acl
查询存储桶 ACL
查询指定存储桶的访问控制列表
对象 ACL
API
操作名
操作描述
PUT Object acl
设置对象 ACL
设置存储桶中某个对象的访问控制列表
GET Object acl
查询对象 ACL
查询对象的访问控制列表
存储桶 ACL
设置存储桶 ACL
功能说明
设置指定存储桶的访问权限控制列表（PUT Bucket acl）。AccessControlPolicy 参数与其它权限参数是互斥的，无法同时指定。
方法原型
put_bucket_acl(Bucket, AccessControlPolicy={}, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.put_bucket_acl(
    Bucket='examplebucket-1250000000',
    ACL='public-read'
)
全部参数请求示例
response = client.put_bucket_acl(
    Bucket='examplebucket-1250000000',
    ACL='private'|'public-read'|'public-read-write',
    GrantFullControl='id="100000000002"',
    GrantRead='id="100000000003",id="100000000004"',
    GrantWrite='id="100000000005"',
    AccessControlPolicy={
        'AccessControlList': {
            'Grant': [
                {
                    'Grantee': {
                        'DisplayName': 'qcs::cam::uin/100000000002:uin/100000000002',
                        'Type': 'CanonicalUser'|'Group',
                        'ID': 'qcs::cam::uin/100000000002:uin/100000000002', # Type为CanonicalUser时必须填写ID
                        'URI': 'http://cam.qcloud.com/groups/global/AllUsers' # Type为Group时必须填写URI
                    },
                    'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
                },
            ]
        },
        'Owner': {
            'DisplayName': 'qcs::cam::uin/100000000001:uin/100000000001', 
            'ID': 'qcs::cam::uin/100000000001:uin/100000000001' # 必须是桶 Owner 的 ID
        }
    }
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
ACL
设置存储桶的 ACL，例如 'private'，'public-read'，'public-read-write'，详情请参见 ACL 概述
String
否
GrantFullControl
赋予指定账户对存储桶的读写权限，格式为id="OwnerUin"，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"
String
否
GrantRead
赋予指定账户对存储桶的读权限，格式为id="OwnerUin"，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"
String
否
GrantWrite
赋予指定账户对存储桶的写权限，格式为id="OwnerUin"，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"
String
否
AccessControlPolicy
赋予指定账户对存储桶的访问权限，与其它权限参数是互斥的，无法同时指定
Dict
否
AccessControlPolicy 参数说明：
参数名称
参数描述
类型
是否必填
Owner
存储桶拥有者的信息，包括 DisplayName 和 ID
Dict
是
AccessControlList
存储桶权限被授予者的信息，包括 Grant 列表
Dict
是
Owner 参数说明：
参数名称
参数描述
类型
是否必填
ID
Type 为 CanonicalUser 时，对应权限授予者的 ID，格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin]，如 qcs::cam::uin/100000000001:uin/100000000001
String
是
DisplayName
权限被授予者的名称，可以不填，或者和ID的值保持一致
String
否
AccessControlList 参数说明：
参数名称
参数描述
类型
是否必填
Grant
存储桶权限被授予者的信息，包括 Grantee 和 Permission
List
是
Grantee
权限被授予者的信息，包括 DisplayName，Type，ID 和 URI
Dict
是
Type
权限被授予者的类型，类型为 CanonicalUser 或者 Group
String
是
ID
Type 为 CanonicalUser 时，对应权限授予者的 ID，格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin]，如 qcs::cam::uin/100000000001:uin/100000000001
String
当 Grantee 的 Type 指定为 CanonicalUser 时必选
URI
Type 为 Group 时，填入预设用户组的 URI，例如 http://cam.qcloud.com/groups/global/AllUsers， 详情请参见 ACL 概述
String
当 Grantee 的 Type 指定为 Group 时必选
Permission
指明授予被授权者的存储桶权限，可选值有 FULL_CONTROL，WRITE，READ，分别对应读写权限、写权限、读权限
String
是
返回结果说明
该方法返回值为 None。
查询存储桶 ACL
功能说明
查询指定存储桶的访问权限控制列表（GET Bucket acl）。
方法原型
get_bucket_acl(Bucket, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.get_bucket_acl(
    Bucket='examplebucket-1250000000'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
返回结果说明
Bucket ACL 信息，类型为 dict。
{
    'Owner': {
        'DisplayName': 'qcs::cam::uin/100000000001:uin/100000000001',
        'ID': 'qcs::cam::uin/100000000001:uin/100000000001'
    },
    'AccessControlList': {
        'Grant': [
            {
                'Grantee': {
                    'DisplayName': 'qcs::cam::uin/100000000002:uin/100000000002',
                    'Type': 'CanonicalUser'|'Group',
                    'ID': 'qcs::cam::uin/100000000002:uin/100000000002',
                    'URI': 'http://cam.qcloud.com/groups/global/AllUsers'
                },
                'Permission': 'FULL_CONTROL'|'WRITE'|'READ'
            },
        ]
    }
}
参数名称
参数描述
类型
Owner
存储桶拥有者的信息，包括 DisplayName 和 ID，详细说明见PUT Bucket acl
Dict
AccessControlList
存储桶权限被授予者的信息，包括 Grant 列表，详细说明见PUT Bucket acl
Dict
对象 ACL
设置对象 ACL
功能说明
设置存储桶中某个对象的访问控制列表（PUT Object acl）。AccessControlPolicy 参数与其它权限参数是互斥的，无法同时指定。
方法原型
put_object_acl(Bucket, Key, AccessControlPolicy={}, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在CosConfig中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的region可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.put_object_acl(
    Bucket='examplebucket-1250000000',
    Key='exampleobject',
    ACL='public-read'
)
全部参数请求示例
response = client.put_object_acl(
    Bucket='examplebucket-1250000000',
    Key='exampleobject',
    ACL='default'|'private'|'public-read',
    GrantFullControl='id="100000000003"',
    GrantRead='id="100000000003",id="100000000004"',
    AccessControlPolicy={
        'AccessControlList': {
            'Grant': [
                {
                    'Grantee': {
                        'DisplayName': 'qcs::cam::uin/100000000002:uin/100000000002',
                        'Type': 'CanonicalUser'|'Group',
                        'ID': 'qcs::cam::uin/100000000002:uin/100000000002', # Type为CanonicalUser时必须填写ID
                        'URI': 'http://cam.qcloud.com/groups/global/AllUsers' # Type为Group时必须填写URI
                    },
                    'Permission': 'FULL_CONTROL'|'READ'
                },
            ]
        },
        'Owner': {
            'DisplayName': 'qcs::cam::uin/100000000001:uin/100000000001',
            'ID': 'qcs::cam::uin/100000000001:uin/100000000001'
        }
    }
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
Key
对象键（Key）是对象在存储桶中的唯一标识。例如，在对象的访问域名examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg中，对象键为 doc/pic.jpg
String
是
ACL
设置对象的 ACL，例如 'default'，'private'，'public-read'，详情请参见 ACL 概述
String
否
GrantFullControl
赋予指定账户对对象的所有权限，格式为id="OwnerUin"，可使用半角逗号（,）分隔多组被授权者，例如id="100000000001",id="100000000002"
String
否
GrantRead
赋予指定账户对对象的读权限，格式为id="OwnerUin"，可使用半角逗号（,）分隔多组被授权者，例如id="100000000001",id="100000000002"
String
否
AccessControlPolicy
赋予指定账户对对象的访问权限，与其它权限参数是互斥的，无法同时指定
Dict
否
AccessControlPolicy 参数说明：
参数名称
参数描述
类型
是否必填
Owner
存储桶拥有者的信息，包括 DisplayName 和 ID
Dict
是
AccessControlList
存储桶权限被授予者的信息，包括 Grant 列表
Dict
是
Owner 参数说明：
参数名称
参数描述
类型
是否必填
ID
Type 为 CanonicalUser 时，对应权限授予者的 ID，格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin]，如 qcs::cam::uin/100000000001:uin/100000000001
String
是
DisplayName
权限被授予者的名称，可以不填，或者和ID的值保持一致
String
否
AccessControlList 参数说明：
参数名称
参数描述
类型
是否必填
Grant
存储桶权限被授予者的信息，包括 Grantee 和 Permission
List
是
Grantee
权限被授予者的信息，包括 DisplayName，Type，ID 和 URI
Dict
是
Type
权限被授予者的类型，类型为 CanonicalUser 或者 Group
String
是
ID
Type 为 CanonicalUser 时，对应权限授予者的 ID，格式为 qcs::cam::uin/[OwnerUin]:uin/[OwnerUin]，如 qcs::cam::uin/100000000001:uin/100000000001
String
当 Grantee 的 Type 指定为 CanonicalUser 时必选
URI
Type 为 Group 时，填入预设用户组的 URI，例如 http://cam.qcloud.com/groups/global/AllUsers， 详情请参见 ACL 概述
String
当 Grantee 的 Type 指定为 Group 时必选
Permission
指明授予被授权者的权限信息，可选值有 FULL_CONTROL，READ，分别对应所有权限、读权限
String
是
返回结果说明
该方法返回值为 None。
查询对象 ACL
功能说明
查询对象的访问控制列表（GET Object acl）。
方法原型
get_object_acl(Bucket, Key, **kwargs)
请求示例
# -*- coding=utf-8
from qcloud_cos import CosConfig
from qcloud_cos import CosS3Client
import sys
import os
import logging
﻿
# 正常情况日志级别使用 INFO，需要定位时可以修改为 DEBUG，此时 SDK 会打印和服务端的通信信息
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
﻿
# 1. 设置用户属性, 包括 secret_id, secret_key, region 等。Appid 已在 CosConfig 中移除，请在参数 Bucket 中带上 Appid。Bucket 由 BucketName-Appid 组成
secret_id = os.environ['COS_SECRET_ID']     # 用户的 SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
secret_key = os.environ['COS_SECRET_KEY']   # 用户的 SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参见 https://www.tencentcloud.com/document/product/598/32675
region = 'ap-beijing'      # 替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.tencentcloud.com/cos5/bucket
                           # COS 支持的所有 region 列表参见 https://www.tencentcloud.com/document/product/436/6224
token = None               # 如果使用永久密钥不需要填入 token，如果使用临时密钥需要填入，临时密钥生成和使用指引参见 https://www.tencentcloud.com/document/product/436/14048
scheme = 'https'           # 指定使用 http/https 协议来访问 COS，默认为 https，可不填
﻿
config = CosConfig(Region=region, SecretId=secret_id, SecretKey=secret_key, Token=token, Scheme=scheme)
client = CosS3Client(config)
﻿
response = client.get_object_acl(
    Bucket='examplebucket-1250000000',
    Key='exampleobject'
)
参数说明
参数名称
参数描述
类型
是否必填
Bucket
存储桶名称，由 BucketName-APPID 构成
String
是
Key
对象键（Key）是对象在存储桶中的唯一标识。例如，在对象的访问域名examplebucket-1250000000.cos.ap-guangzhou.myqcloud.com/doc/pic.jpg中，对象键为 doc/pic.jpg
String
是
返回结果说明
Object ACL 信息，类型为 dict：
{
    'Owner': {
        'DisplayName': 'qcs::cam::uin/100000000001:uin/100000000001',
        'ID': 'qcs::cam::uin/100000000001:uin/100000000001'
    },
    'AccessControlList': {
        'Grant': [
            {
                'Grantee': {
                    'DisplayName': 'qcs::cam::uin/100000000002:uin/100000000002',
                    'Type': 'CanonicalUser'|'Group',
                    'ID': 'qcs::cam::uin/100000000002:uin/100000000002',
                    'URI': 'http://cam.qcloud.com/groups/global/AllUsers'
                },
                'Permission': 'FULL_CONTROL'|'READ'
            },
        ]
    }
}
参数名称
参数描述
类型
Owner
对象拥有者的信息，包括 DisplayName 和 ID，详细说明见PUT Object acl
Dict
AccessControlList
对象权限被授予者的信息，包括 Grant 列表，详细说明见PUT Object acl
Dict

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

对象存储

访问控制

简介

存储桶 ACL

设置存储桶 ACL

功能说明

方法原型

请求示例

全部参数请求示例

参数说明

返回结果说明

查询存储桶 ACL

功能说明

方法原型

请求示例

参数说明

返回结果说明

对象 ACL

设置对象 ACL

功能说明

方法原型

请求示例

全部参数请求示例

参数说明

返回结果说明

查询对象 ACL

功能说明

方法原型

请求示例

参数说明

返回结果说明

帮助和支持

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

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

参数名称	参数描述	类型	是否必填
Bucket	存储桶名称，由 BucketName-APPID 构成	String	是
ACL	设置存储桶的 ACL，例如 'private'，'public-read'，'public-read-write'，详情请参见 ACL 概述	String	否
GrantFullControl	赋予指定账户对存储桶的读写权限，格式为`id="OwnerUin"`，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"	String	否
GrantRead	赋予指定账户对存储桶的读权限，格式为`id="OwnerUin"`，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"	String	否
GrantWrite	赋予指定账户对存储桶的写权限，格式为`id="OwnerUin"`，可使用半角逗号（,）分隔多组被授权者，如 id="100000000001",id="100000000002"	String	否
AccessControlPolicy	赋予指定账户对存储桶的访问权限，与其它权限参数是互斥的，无法同时指定	Dict	否