如何使用Python SDK V2管理文件访问权限_对象存储(OSS)-阿里云帮助中心

本文介绍如何使用Python SDK V2设置并获取文件的访问权限（ACL）。

注意事项

本文示例代码以华东1（杭州）的地域IDcn-hangzhou为例，默认使用外网Endpoint，如果您希望通过与OSS同地域的其他阿里云产品访问OSS，请使用内网Endpoint。关于OSS支持的Region与Endpoint的对应关系，请参见OSS地域和访问域名。
要设置Object访问权限，您必须具有oss:PutObjectAcl权限；要获取Object访问权限，您必须具有oss:GetObjectAcl权限。具体操作，请参见为RAM用户授权自定义的权限策略。

方法定义

设置文件读写权限

put_object_acl(request: PutObjectAclRequest, **kwargs) → PutObjectAclResult

读取文件读写权限

get_object_acl(request: GetObjectAclRequest, **kwargs) → GetObjectAclResult

请求参数列表

参数名	类型	说明

参数名	类型	说明
request	PutObjectAclRequest	设置请求参数，具体请参见PutObjectAclRequest
request	GetObjectAclRequest	设置请求参数，具体请参见GetObjectAclRequest

返回值列表

类型	说明

类型	说明
PutObjectAclResult	返回值，具体请参见PutObjectAclResult
GetObjectAclResult	返回值，具体请参见GetObjectAclResult

关于设置文件读写权限方法的完整定义，请参见put_object_acl。

关于获取文件读写权限方法的完整定义，请参见get_object_acl。

读写权限类型

文件的访问权限（ACL）有以下四种：

访问权限	描述	访问权限值

访问权限	描述	访问权限值
继承Bucket	文件遵循存储空间的访问权限。	default
私有	文件的拥有者和授权用户有该文件的读写权限，其他用户没有权限操作该文件。	private
公共读	文件的拥有者和授权用户有该文件的读写权限，其他用户只有文件的读权限。请谨慎使用该权限。	public-read
公共读写	所有用户都有该文件的读写权限。请谨慎使用该权限。	public-read-write

文件的访问权限优先级高于存储空间的访问权限。例如存储空间的访问权限是私有，而文件的访问权限是公共读写，则所有用户都有该文件的读写权限。如果某个文件没有设置过访问权限，则遵循存储空间的访问权限。

示例代码

您可以使用以下代码设置并获取文件的访问权限。

import argparse
import alibabacloud_oss_v2 as oss

# 创建一个命令行参数解析器
parser = argparse.ArgumentParser(description="put object acl sample")
# 添加必要的参数：区域、存储空间名称、对象键名以及访问控制列表（ACL）
parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
parser.add_argument('--bucket', help='The name of the bucket.', required=True)
parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
parser.add_argument('--key', help='The name of the object.', required=True)
parser.add_argument('--acl', help='Specify the access permission ACL for the object.', required=True)

def main():
    # 解析命令行输入的参数
    args = parser.parse_args()

    # 从环境变量中加载访问凭证信息
    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()

    # 使用SDK默认配置
    cfg = oss.config.load_default()
    # 设置凭证提供者
    cfg.credentials_provider = credentials_provider
    # 设置用户提供的区域信息
    cfg.region = args.region
    # 如果提供了endpoint，则设置endpoint到配置中
    if args.endpoint is not None:
        cfg.endpoint = args.endpoint

    # 创建OSS客户端
    client = oss.Client(cfg)

    # 设置对象的ACL权限
    result = client.put_object_acl(oss.PutObjectAclRequest(
        bucket=args.bucket,  # 存储空间名称
        key=args.key,  # 对象键名
        acl=args.acl,  # 新的ACL值
    ))

    # 打印设置ACL后的输出信息
    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' version id: {result.version_id},'
    )

    # 获取并打印当前对象的ACL设置
    result = client.get_object_acl(oss.GetObjectAclRequest(
        bucket=args.bucket,
        key=args.key,
    ))

    print(f'status code: {result.status_code},'
          f' request id: {result.request_id},'
          f' acl: {result.acl},'
          f' version id: {result.version_id},'
    )

# 当直接运行此脚本时调用main函数
if __name__ == "__main__":
    main()

Python管理文件访问权限