如何使用Python SDK V2管理檔案存取權限 - Object Storage Service

本文介紹如何使用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()

Object Storage Service：管理檔案存取權限（Python SDK V2）